fi_seo 0.1.0

data/config/routes.rb

@@ -0,0 +1,7 @@
+Rails.application.routes.draw do
+  sitemap_enable = false
+  sitemap_enable = true if FiSeo.initialized_config.sitemap_enable == true
+  if sitemap_enable
+    get 'sitemap' => 'sitemap#sitemap', format: true
+  end
+end

data/fi_seo.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/acts_as_seoable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'fi_seo'
+  spec.version       = FiSeo::VERSION
+  spec.authors       = ['Banura Randika']
+  spec.email         = ['info@fidenz.com', 'tech@fidenz.com', 'banura.r@fidenz.com']
+
+  spec.summary       = 'Flexible SEO solution for rails projects'
+  spec.description   = 'This gem provides a easier solution to search engine optimization(SEO) in a ruby project. This will give you the seo capabilities to your static pages anddynamic pages alike with few lines of code.
+                        Also site maps are essential to the SEO of your web application. So this gem gives that capabilities with a feature to integrate google analytics.'
+  spec.homepage      = 'https://github.com/fidenz-developer/fi-seo.git'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'activerecord', '~> 5.0', '>= 5.0.0.1'
+  spec.add_runtime_dependency('meta-tags', '~> 2.13')
+  spec.add_runtime_dependency 'xml-sitemap', '~> 1.3', '>= 1.3.3'
+end

data/lib/acts_as_seoable/dynamic_seo.rb

@@ -0,0 +1,6 @@
+class DynamicSeo < ActiveRecord::Base
+
+  belongs_to :seoable, polymorphic: true
+  validates_presence_of   :seoable_type, :seoable_id
+  validates_uniqueness_of :seoable_id, scope: :seoable_type
+end

data/lib/acts_as_seoable/engine.rb

@@ -0,0 +1,6 @@
+module ActsAsSeoable
+  class Engine < ::Rails::Engine
+    isolate_namespace ActsAsSeoable
+  end
+end
+

data/lib/acts_as_seoable/google_analytic_seo.rb

@@ -0,0 +1,5 @@
+class GoogleAnalyticSeo < ActiveRecord::Base
+
+  validates_presence_of :title
+  validates_presence_of :content, allow_blank: true
+end

data/lib/acts_as_seoable/helpers/sitemap_helper.rb

@@ -0,0 +1,32 @@
+require 'acts_as_seoable/sitemap_seo'
+
+module SitemapClassMethods
+
+  def create_sitemap_seo_records
+    Rails.application.reload_routes!
+    routes = Rails.application.routes.routes.select { |r| r.defaults.include? :sitemap}
+    row_routes = Array.new
+
+    routes.each do |route|
+      next if route.defaults[:sitemap] != true || route.verb != 'GET'
+      
+      static = route.defaults[:static] == true
+      row = SitemapSeo.find_by_sitemap_controller_and_sitemap_action(route.defaults[:controller], route.defaults[:action])
+      if row.nil?
+        new_row = SitemapSeo.create(sitemap_controller: route.defaults[:controller], sitemap_action: route.defaults[:action],
+                                    status: false, static: static)
+        row_routes << new_row
+      else
+        row.update(static: static)
+        row.save
+        row_routes << row
+      end
+    end
+
+    SitemapSeo.all.each do |sitemap_seo|
+      next if row_routes.include? sitemap_seo
+
+      sitemap_seo.delete
+    end
+  end
+end

data/lib/acts_as_seoable/helpers/static_helper.rb

@@ -0,0 +1,94 @@
+require 'acts_as_seoable/static_seo'
+require 'meta-tags'
+
+module ActsAsSeoableStaticClassMethods
+
+  def create_static_seo_records
+    Rails.application.reload_routes!
+    routes = Rails.application.routes.routes.select { |r| r.defaults.include? :acts_as_seoable }
+    row_routes = Array.new
+
+    routes.each do |route|
+      row = StaticSeo.find_by_seoable_controller_and_seoable_action(route.defaults[:controller], route.defaults[:action])
+      status = route.defaults[:acts_as_seoable] == true
+      if row.nil?
+        new_row = StaticSeo.create(seoable_controller: route.defaults[:controller], seoable_action: route.defaults[:action],
+                         title: '', description: '', keywords: '', status: status)
+        row_routes << new_row
+      else
+        row_routes << row
+        row.update(status: status)
+      end
+    end
+
+    StaticSeo.all.each do |static_seo|
+      next if row_routes.include? static_seo
+
+      static_seo.delete
+    end
+  end
+
+  def create_static_meta_tags(controller_name, action_name, _options = {})
+    FiSeo::create_static_seo_records
+
+    configuration = { reverse: false,
+                      lowercase: false,
+                      index: false,
+                      noindex: false,
+                      nofollow: false,
+                      follow: false,
+                      noarchive: false,
+                      separator: '&#124;',
+                      canonical: false,
+                      canonical_url: '',
+                      social: false }
+    configuration.update(_options) if _options.present?
+    row = StaticSeo.find_by_seoable_controller_and_seoable_action(controller_name, action_name)
+    hash = if row.nil? || (row && row.status == false)
+             {
+               title: '',
+               description: '',
+               keywords: ''
+             }
+           else
+             static_hash = {
+               title: row.title,
+               description: row.description,
+               keywords: row.keywords,
+               lowercase: configuration[:lowercase],
+               reverse: configuration[:reverse],
+               index: configuration[:index],
+               noindex: configuration[:noindex],
+               follow: configuration[:follow],
+               nofollow: configuration[:nofollow],
+               noarchive: configuration[:noarchive],
+               separator: configuration[:separator].html_safe
+             }
+             if configuration[:canonical].present?
+               static_hash.merge!(canonical: configuration[:canonical_url])
+             end
+             if configuration[:social].present?
+               if configuration[:social].include? :facebook
+                 static_hash.merge!(og: {
+                   title: row.facebook_title.blank? ? '' : row.facebook_title,
+                   type: row.facebook_type.blank? ? '' : row.facebook_type,
+                   url: row.facebook_url.blank? ? '' : row.facebook_url,
+                   image: row.facebook_image.blank? ? '' : row.facebook_image,
+                   description: row.facebook_description.blank? ? '' : row.facebook_description
+                 })
+               end
+               if configuration[:social].include? :twitter
+                 static_hash.merge!(twitter: {
+                   title: row.twitter_title.blank? ? '' :  row.twitter_title,
+                   card: row.twitter_card.blank? ? '' :  row.twitter_card,
+                   site: row.twitter_site.blank? ? '' :  row.twitter_site,
+                   image: row.twitter_image.blank? ? '' :  row.twitter_image,
+                   description: row.twitter_description.blank? ? '' :  row.twitter_description
+                 })
+               end
+             end
+             static_hash
+           end
+    hash
+  end
+end

data/lib/acts_as_seoable/sitemap_seo.rb

@@ -0,0 +1,10 @@
+
+class SitemapSeo < ActiveRecord::Base
+
+  validates_presence_of   :sitemap_action, :sitemap_controller
+  validates_uniqueness_of :sitemap_action, scope: :sitemap_controller
+  validates_numericality_of :priority, greater_than_or_equal_to: 0, less_than_or_equal_to: 1
+
+
+  enum period: { not_available: 0, always: 1, hourly: 2, daily: 3, weekly: 4, monthly: 5,yearly: 6, never: 7 }
+end

data/lib/acts_as_seoable/static_seo.rb

@@ -0,0 +1,5 @@
+class StaticSeo < ActiveRecord::Base
+
+  validates_presence_of   :seoable_controller, :seoable_action
+  validates_uniqueness_of :seoable_action, scope: :seoable_controller
+end

data/lib/acts_as_seoable/version.rb

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

data/lib/fi_seo.rb

@@ -0,0 +1,205 @@
+# frozen_string_literal: true
+
+require 'meta-tags'
+require 'xml-sitemap'
+
+require 'acts_as_seoable/version'
+require 'active_record'
+require 'active_record/version'
+require 'active_support/core_ext/module'
+require 'active_support/core_ext/hash'
+require 'generators/acts_as_seoable/migrate/migrate_generator'
+require 'acts_as_seoable/dynamic_seo'
+require 'acts_as_seoable/static_seo'
+require 'acts_as_seoable/google_analytic_seo'
+require 'acts_as_seoable/sitemap_seo'
+require 'acts_as_seoable/engine'
+require 'acts_as_seoable/helpers/static_helper'
+require 'acts_as_seoable/helpers/sitemap_helper'
+
+module FiSeo
+  extend ActiveSupport::Concern
+  extend SitemapClassMethods
+  extend ActsAsSeoableStaticClassMethods
+
+  class << self
+    attr_accessor :initialized_config
+  end
+
+  def self.initialized_config
+    @initialized_config ||= Configuration.new
+  end
+
+  def self.configure
+    yield(initialized_config)
+  end
+
+  class Configuration
+    attr_accessor :default_facebook_title
+    attr_accessor :default_facebook_url
+    attr_accessor :default_facebook_type
+    attr_accessor :default_facebook_image
+    attr_accessor :default_facebook_description
+    attr_accessor :default_twitter_title
+    attr_accessor :default_twitter_card
+    attr_accessor :default_twitter_site
+    attr_accessor :default_twitter_image
+    attr_accessor :default_twitter_description
+    attr_accessor :default_canonical_url
+    attr_accessor :sitemap_host_url
+    attr_accessor :sitemap_enable
+
+    def initialize
+      @default_facebook_title = ''
+      @default_facebook_url = ''
+      @default_facebook_type = ''
+      @default_facebook_image = ''
+      @default_facebook_description = ''
+      @default_twitter_title = ''
+      @default_twitter_card = ''
+      @default_twitter_site = ''
+      @default_twitter_image = ''
+      @default_twitter_description = ''
+      @default_canonical_url = ''
+      @sitemap_host_url = 'www.domain.com'
+      @sitemap_enable = true
+
+    end
+  end
+
+  module ClassMethods
+
+    def acts_as_seoable(title, description, keywords, _options = {})
+      extend  ActsAsSeoableClassMethods
+      include ActsAsSeoableInstanceMethods
+
+      attr_names = [title, description, keywords]
+      configuration = { check_for_changes: true,
+                        reverse: false,
+                        lowercase: false,
+                        index: false,
+                        noindex: false,
+                        nofollow: false,
+                        follow: false,
+                        noarchive: false,
+                        social: false,
+                        separator: '&#124;',
+                        canonical: false }
+      configuration.update(_options) if _options.present?
+      configuration[:fields] = attr_names.flatten.uniq.compact
+
+      class_attribute :seoable_options
+      self.seoable_options = configuration
+
+      self.send('after_create', :create_dynamic_seo_record)
+      self.send('after_update', :update_dynamic_seo_record)
+      self.send('has_one', :dynamic_seo, as: :seoable, dependent: :delete)
+      self.send('accepts_nested_attributes_for', :dynamic_seo)
+    end
+  end
+
+  def self.included(receiver)
+    receiver.extend(ClassMethods)
+  end
+
+  module ActsAsSeoableClassMethods
+
+    def seoable_fields
+      self.seoable_options[:fields]
+    end
+  end
+
+  module ActsAsSeoableInstanceMethods
+
+    def to_meta_tags
+      row = DynamicSeo.find_by_seoable_type_and_seoable_id(self.class.to_s, self.id)
+      if row.nil?
+        {}
+      else
+        hash = {
+          title: row.title,
+          description: row.description,
+          keywords: row.keywords,
+          lowercase: self.class.seoable_options[:lowercase],
+          reverse: self.class.seoable_options[:reverse],
+          index: self.class.seoable_options[:index],
+          noindex: self.class.seoable_options[:noindex],
+          follow: self.class.seoable_options[:follow],
+          nofollow: self.class.seoable_options[:nofollow],
+          noarchive: self.class.seoable_options[:noarchive],
+          separator: self.class.seoable_options[:separator].html_safe
+        }
+
+        if self.class.seoable_options[:social].present?
+          if self.class.seoable_options[:social].include? :facebook
+            hash.merge!(og: facebook_tags)
+          end
+          if self.class.seoable_options[:social].include? :twitter
+            hash.merge!(twitter: twitter_tags)
+          end
+        end
+        if self.class.seoable_options[:canonical].present?
+          hash.merge!(canonical: canonical_url)
+        end
+        hash
+      end
+    end
+
+
+
+    def create_dynamic_seo_record
+      DynamicSeo.create(seoable_type: self.class.to_s, seoable_id: id, title: self.title_value,
+                        description: self.description_value, keywords: self.keywords_value)
+    end
+
+    def update_dynamic_seo_record
+      if self.class.seoable_options[:check_for_changes]
+        row = DynamicSeo.find_by_seoable_type_and_seoable_id(self.class.to_s, self.id)
+        if row.nil?
+          self.create_dynamic_seo_record
+        else
+          DynamicSeo.where(seoable_type: self.class.to_s).where(seoable_id: self.id)
+                    .update_all(title: self.title_value, description: self.description_value, keywords: self.keywords_value)
+        end
+      end
+    end
+
+    def facebook_tags
+      {
+        title: FiSeo.initialized_config.default_facebook_title,
+        type: FiSeo.initialized_config.default_facebook_type,
+        url: FiSeo.initialized_config.default_facebook_url,
+        image: FiSeo.initialized_config.default_facebook_image,
+        description: FiSeo.initialized_config.default_facebook_description
+      }
+    end
+
+    def twitter_tags
+      {
+        title: FiSeo.initialized_config.default_twitter_title,
+        card: FiSeo.initialized_config.default_twitter_card,
+        site: FiSeo.initialized_config.default_twitter_site,
+        image: FiSeo.initialized_config.default_twitter_image,
+        description: FiSeo.initialized_config.default_twitter_description
+      }
+    end
+
+    def canonical_url
+      FiSeo.initialized_config.default_canonical_url
+    end
+
+    def title_value
+      self.send(self.class.seoable_fields.first)
+    end
+
+    def description_value
+      self.send(self.class.seoable_fields.second)
+    end
+
+    def keywords_value
+      self.send(self.class.seoable_fields.third)
+    end
+  end
+end
+
+ActiveRecord::Base.send(:include, FiSeo)

data/lib/generators/acts_as_seoable/admin/admin_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators'
+
+module ActsAsSeoable
+  module Generators
+    class AdminGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      def generate_config_file
+        if Gem.loaded_specs.has_key?('activeadmin')
+          template 'admin.rb', 'app/admin/acts_as_seoable.rb'
+        else
+          raise StandardError, 'Could not generate activeadmin page without activeadmin installed.'
+        end
+      end
+    end
+  end
+end

data/lib/generators/acts_as_seoable/admin/templates/admin.rb

@@ -0,0 +1,250 @@
+
+ActiveAdmin.register_page 'SEOData' do
+  menu label: 'SEO Data', url: '#'
+end
+
+ActiveAdmin.register StaticSeo do
+  menu label: 'Static Pages', priority: 1, parent: 'SEOData'
+  config.filters = false
+  actions :all, except: %i[destroy new]
+  
+  show title: proc { |static_seo| "#{static_seo.seoable_controller.titleize} - #{static_seo.seoable_action.titleize}" } do
+    attributes_table do
+      row('Controller', &:seoable_controller)
+      row('Action', &:seoable_action)
+      row :title
+      row :description
+      row :keywords
+      row :status
+      row :facebook_title
+      row :facebook_url
+      row :facebook_type
+      row :facebook_image
+      row :facebook_description
+      row :twitter_title
+      row :twitter_card
+      row :twitter_site
+      row :twitter_image
+      row :twitter_description
+      row :created_at
+      row :updated_at
+    end
+  end
+  
+  index title: 'Static SEO' do
+    column 'Controller' do |static_seo|
+      static_seo.seoable_controller.titleize
+    end
+    column 'Action' do |static_seo|
+      static_seo.seoable_action.titleize
+    end
+    column :title
+    column :created_at
+    column :updated_at
+    actions
+  end
+  
+  form do |f|
+    f.inputs do
+      f.input :seoable_controller, input_html: { readonly: true }
+      f.input :seoable_action, input_html: { readonly: true }
+      f.input :title
+      f.input :description
+      f.input :keywords
+      f.input :status
+      f.input :facebook_title
+      f.input :facebook_url
+      f.input :facebook_type
+      f.input :facebook_image
+      f.input :facebook_description
+      f.input :twitter_title
+      f.input :twitter_card
+      f.input :twitter_site
+      f.input :twitter_image
+      f.input :twitter_description
+    end
+    f.actions
+  end
+  
+  controller do
+    def permitted_params
+      params.permit!
+    end
+  end
+end
+
+ActiveAdmin.register DynamicSeo do
+  menu label: 'Dynamic Pages', priority: 2, parent: 'SEOData'
+  config.filters = false
+  actions :all, except: %i[destroy new edit show]
+  
+  index title: 'Dynamic SEO' do
+    column 'Type' do |dynamic_seo|
+      dynamic_seo.seoable_type.titleize
+    end
+    column 'Item Count' do |dynamic_seo|
+      DynamicSeo.where(seoable_type: dynamic_seo.seoable_type).count
+    end
+    actions defaults: true do |dynamic_seo|
+      link_to('View All', "/admin/dynamic_seo_by_types?type=#{dynamic_seo.seoable_type}")
+    end
+  end
+  
+  controller do
+    def permitted_params
+      params.permit!
+    end
+    
+    def scoped_collection
+      arr_of_distinct_types = DynamicSeo.all.group_by(&:seoable_type).collect{|k,v| v.first}
+      DynamicSeo.where(id: arr_of_distinct_types.map(&:id))
+    end
+  end
+end
+
+ActiveAdmin.register DynamicSeo, as: 'DynamicSEO By Type' do
+  menu false
+  config.filters = false
+  actions :all, except: %i[destroy new edit]
+  config.breadcrumb = false
+  
+  show do
+    attributes_table do
+      row 'Type' do |dyanamic_seo|
+        dyanamic_seo.seoable_type.titleize
+      end
+      row 'Id' do |dynamic_seo|
+        dynamic_seo.seoable_id
+      end
+      row 'Title' do |dynamic_seo|
+        dynamic_seo.title.titleize
+      end
+      row :description
+      row :keywords
+      row :created_at
+      row :updated_at
+    end
+  end
+  
+  index title: proc { |dynamic_seo| "Dynamic SEO - #{params[:type]}" } do
+    column 'Type' do |dynamic_seo|
+      dynamic_seo.seoable_type.titleize
+    end
+    column 'Id' do |dynamic_seo|
+      dynamic_seo.seoable_id
+    end
+    column 'Title' do |dynamic_seo|
+      dynamic_seo.title.titleize
+    end
+    column :created_at
+    column :updated_at
+    actions defaults: false do |dynamic_seo|
+      link_to('View', "/admin/dynamic_seo_by_types/#{dynamic_seo.id}?type=#{dynamic_seo.seoable_type}")
+    end
+  end
+  
+  controller do
+    def permitted_params
+      params.permit!
+    end
+    
+    def scoped_collection
+      DynamicSeo.where(seoable_type: params[:type])
+    end
+  end
+end
+
+ActiveAdmin.register SitemapSeo do
+  menu label: 'Sitemap Seo', priority: 3, parent: 'SEOData'
+  config.filters = false
+  actions :all, except: %i[destroy new]
+  
+  show title: proc { |sitemap_seo| "#{sitemap_seo.sitemap_controller.titleize} - #{sitemap_seo.sitemap_action.titleize}" } do
+    attributes_table do
+      row('Controller', &:sitemap_controller)
+      row('Action', &:sitemap_action)
+      row :priority
+      row 'Period' do |sitemap_seo|
+        sitemap_seo.period.titleize
+      end
+      row :status
+      row :created_at
+      row :updated_at
+    end
+  end
+  
+  index title: 'Sitemap Seo' do
+    column 'Controller' do |sitemap_seo|
+      sitemap_seo.sitemap_controller.titleize
+    end
+    column 'Action' do |sitemap_seo|
+      sitemap_seo.sitemap_action.titleize
+    end
+    column :priority
+    column 'Period' do |sitemap_seo|
+      sitemap_seo.period.titleize
+    end
+    column :status
+    column :created_at
+    column :updated_at
+    actions
+  end
+  
+  form do |f|
+    f.inputs do
+      f.input :sitemap_controller, input_html: { readonly: true }
+      f.input :sitemap_action, input_html: { readonly: true }
+      f.input :priority
+      f.input :period, as: :select, collection: SitemapSeo.periods.keys.map {|e|[e.titleize, e]}
+      f.input :status
+    end
+    f.actions
+  end
+  
+  controller do
+    def permitted_params
+      params.permit!
+    end
+  end
+end
+
+ActiveAdmin.register GoogleAnalyticSeo do
+  menu label: 'Google Analytics', priority: 4, parent: 'SEOData'
+  config.filters = false
+  actions :all, except: %i[destroy new]
+  
+  show title: proc { |google_analytic| "#{google_analytic.title.titleize}" } do
+    attributes_table do
+      row 'Title' do |google_analytic|
+        google_analytic.title.titleize
+      end
+      row :content
+      row :created_at
+      row :updated_at
+    end
+  end
+  
+  index title: 'Google Analytics' do
+    column 'Title' do |google_analytic|
+      google_analytic.title.titleize
+    end
+    column :content
+    column :created_at
+    column :updated_at
+    actions
+  end
+  
+  form do |f|
+    f.inputs do
+      f.input :title, input_html: { readonly: true }
+      f.input :content
+    end
+    f.actions
+  end
+  
+  controller do
+    def permitted_params
+      params.permit!
+    end
+  end
+end