fi_seo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4b6862bad29b1fb7ce90cab401d565ee92516c9ace05e8ebb9936e317549506
+  data.tar.gz: 82faae7924d91bbf8e63071fb6b75e3dd0403c3ac854df138eb374a635de7bbf
+SHA512:
+  metadata.gz: a239940436fe911a43d9e90fdbe740ae0799bd5b5e242e88af7c931e6872ae9d87ae085913d11003e69704ab666810a262b92afbb5e4ea599066ae2a93d62a64
+  data.tar.gz: 277b06536793f9f15cb35cae8ad76ce162596c852e834459f6be49ffa9a552fd0ca39caf8b1bc75d522678266c3919bb87f073dd81bb1eedbf345a8eea933836

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# Remove .idea files from project (specified for JetBrains RubyMine)
+.idea/
+*.iml
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+2.6.3

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fi_seo.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'meta-tags', '~> 2.13'
+gem 'activerecord','~> 5.0', '>= 5.0.0.1'
+gem 'xml-sitemap', '~> 1.3', '>= 1.3.3'

data/Gemfile.lock

@@ -0,0 +1,93 @@
+PATH
+  remote: .
+  specs:
+    fi_seo (0.1.0)
+      activerecord (~> 5.0, >= 5.0.0.1)
+      meta-tags (~> 2.13)
+      xml-sitemap (~> 1.3, >= 1.3.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.4.2)
+      actionview (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.4.2)
+      activesupport (= 5.2.4.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activemodel (5.2.4.2)
+      activesupport (= 5.2.4.2)
+    activerecord (5.2.4.2)
+      activemodel (= 5.2.4.2)
+      activesupport (= 5.2.4.2)
+      arel (>= 9.0)
+    activesupport (5.2.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    diff-lcs (1.3)
+    erubi (1.9.0)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    meta-tags (2.13.0)
+      actionpack (>= 3.2.0, < 6.1)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    xml-sitemap (1.3.3)
+      builder (>= 2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (~> 5.0, >= 5.0.0.1)
+  fi_seo!
+  meta-tags (~> 2.13)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  xml-sitemap (~> 1.3, >= 1.3.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,309 @@
+# FiSeo
+
+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 and dynamic 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.
+
+This gem currently integrate with the Active Admin for management of the gem. Dynamic pages and other settings also include with the integration.
+
+
+## Goals
+
+1. To give ability to easily integrate seo solution with your application.
+2. Give most popular seo strategies in a compact package.
+3. To reduce the development time by substantial amount. 
+
+## Dependencies
+
+This gem depend on:
+* activerecord
+* meta-tags
+* xml-sitemap
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fi_seo'
+```
+
+And then execute:
+
+    $ bundle install
+    
+After updating your bundle, run the migration as follows:
+
+    $ acts_as_seoable:migrate
+    $ rails db:migrate
+    
+## Usage
+
+First, add this code to your main layout:
+
+```erbruby
+# application.html.erb
+
+<head>
+  <%= display_meta_tags site: 'My website' %>
+</head>
+```
+### Options
+ These options can be used in the both static pages and dynamic pages. For examples please refer each usage guides.
+  
+| Option         | Description |
+| -------------- | ----------- |
+| `:separator`   | text used to separate website name from page title |
+| `:lowercase`   | when true, the page name will be lowercase |
+| `:reverse`     | when true, the page and site names will be reversed |
+| `:noindex`     | add noindex meta tag; when true, 'robots' will be used; accepts a string with a robot name, or an array of strings |
+| `:index`       | add index meta tag; when true, 'robots' will be used; accepts a string with a robot name, or an array of strings |
+| `:nofollow`    | add nofollow meta tag; when true, 'robots' will be used; accepts a string with a robot name, or an array of strings |
+| `:follow`      | add follow meta tag; when true, 'robots' will be used; accepts a string with a robot name, or an array of strings |
+| `:noarchive`   | add noarchive meta tag; when true, 'robots' will be used; accepts a string with a robot name, or an array of strings |
+| `:canonical`   | add canonical link tag |
+
+### Static Pages
+
+For static pages you need to configure routes as follows:
+```ruby
+# routes.rb
+
+root 'pages#home', defaults: { acts_as_seoable: true }
+```
+
+In routes you need to add defaults arguments to a static page.
+You also can set act_as_seoable to false as well. But any other value used will also be considered as a false hence will not be a seoable route.
+
+If you ran the server after this you would not see any different. Because we need to render the meta tags to the page. See following example for that:
+```ruby
+# some_controller.rb
+
+def home
+  set_meta_tags FiSeo.create_static_meta_tags(controller_name, action_name, social:%i[facebook twitter])
+end
+```
+
+If you want to include any above mention options to meta tags You do that as follows:
+
+```ruby
+# some_controller.rb
+
+def home
+  set_meta_tags FiSeo.create_static_meta_tags(controller_name, action_name, social:%i[facebook twitter], lowercase: true, noindex: true)
+end
+```
+
+If the few action in a same controller with static pages use this instead:
+
+```ruby
+# application_controller.rb
+
+def static_meta_tag_creation
+  set_meta_tags FiSeo.create_static_meta_tags(controller_name, action_name)
+end
+
+# any_controller
+
+before_action :static_meta_tag_creation
+```
+
+Note:  You can use any method name for before action method
+
+### Dynamic Pages
+
+For dynamic seoable pages you need to configure model as follows:
+```ruby
+# model.rb
+
+acts_as_seoable :title, :description, :keywords
+```
+    
+If the model has attributes for that you need to use for the seoable attributes you can add as above. You can also build and set by method as well.
+```ruby
+# model.rb  
+ 
+acts_as_seoable :title_seoable, :description, :keywords
+
+def title_seoable
+"#{self.name}#{self.id}"
+end
+```  
+ when you create a new record from this model the gem will create a corresponding seoable record as well. Above values will be set as default values.
+ 
+ 
+For dynamic records you can have option set for the model.
+
+And here are a few examples to give you ideas.
+
+```ruby
+# model.rb
+
+acts_as_seoable :title, :description, :keywords, social: [:facebook, :twitter], noindex: true
+
+# model.rb
+
+acts_as_seoable :title, :description, :keywords, social: [:facebook, :twitter], lowercase: true
+```  
+
+For social tags default they are empty. It can be set by the model as follows:
+
+```ruby
+# model.rb
+
+def facebook_tags
+  {
+    title: 'title',
+    type: 'type',
+    url: 'url',
+    image: 'image_url',
+    description: 'description'
+  }
+end
+
+def twitter_tags
+  {
+    title: 'title',
+    card: 'card',
+    site: 'site_url',
+    image: 'image_url',
+    description: 'description'
+  }
+end
+```
+
+### Sitemap
+
+For sitemap you need to configure as follows:
+```ruby
+# routes.rb
+
+root 'pages#home', defaults: { sitemap: true, static: true }
+```
+For static pages in the sitemap you must user static as true in the route. Otherwise this route will considered as dynamic route.
+
+After that restart you server and you will able to see your sitemap at the path of:
+    
+    your_address/sitemap.xml
+
+### Google Analytics
+
+First, add this code to your main layout:
+
+```erb
+# application.html.erb
+
+<head>
+ <%= render 'google_analytics/acts_as_seoable' %>
+</head>
+```
+
+Then you can edit the analytic Id from the backend.
+
+### Generators
+
+There are few initializers and generators for this gem to help you to configure the behavior of the gem.
+#### Migration
+
+Before using the gem you need to migrate the tables for gem to databalse. To get the migration run the following code:
+```bash
+$ acts_as_seoable:migrate
+```
+#### Gem Initializer
+This initializer will give ability to set few social configuration and website name for seo and few other things.
+Run the following code for to create initializer:
+```bash
+$ acts_as_seoable:install
+```
+#### Active Admin Page
+*Only if you are using active admin*
+
+To add SEO data to active admin you need to run following code. This will generate a admin page:
+```bash
+$ acts_as_seoable:admin
+```
+
+#### Active Admin View Helper
+*Only if you are using active admin*
+
+To add active admin view helper you need to run following code. This will generate a **arb** file to add dynamic pages show and edit action:
+```bash
+$ acts_as_seoable:admin_view_helper
+```
+
+### Active Admin
+
+This gem is fully compatible with the active admin gem. To use run generator command to get a active admin page for all of data this gem has to offer.
+Then you can configure it to your likings.
+
+Special feature of this is you are able to add dynamic records that are **seoable** can be edited of viewed. For example if a model seoable configured
+you can add to following code view data in active admin.
+
+```erbruby
+# app/admin/user.rb
+
+show do |user|
+  render partial: 'acts_as_seoable/view_helper', locals: { seoable: user, action: 'show' }
+end
+```  
+
+You must add action and seoable variables as locals to work. action can has either **show** or **edit** variables.
+
+To edit seo variables from active admin first you need to allow params to permit by the active admin. Then you can edit view helper to edit values.
+
+```erbruby
+# app/admin/user.rb
+
+permit_params: dynamic_seos: [:title, :description, :keywords]
+``` 
+Then: 
+```erbruby
+# app/admin/user.rb
+
+form do |f|
+  if f.object.dynamic_seo.present?
+    render partial: 'acts_as_seoable/view_helper', locals: { seoable: f, action: 'edit '}
+  end
+end
+```
+
+### Screenshots
+
+![activeadmin-dynamic-seoable](./screenshots/dynamic-pages-seoable.png)
+
+Above image show how active admin backend let you configure the dynamic **seoable** records. To achieve this please
+follow dynamic pages active admin guidelines.
+ 
+![activeadmin-static-seoable](./screenshots/static-pages-seoable.png)
+
+Above image show how the static routes can be configured using active admin generator. It will capture the routes and show
+it in here to edit.
+
+![activeadmin-static-seoable-frontend](./screenshots/static-pages-seoable-details.png)
+
+Above image show how the meta details has been configured from the backend using active admin for a static route. 
+These details will appear in the frontend (inside the head tag).
+
+![activeadmin-static-seoable-frontend](./screenshots/static-pages-seoable-frontend.png)
+
+Above image show how the meta tags has been rendered inside the head tag for a static page.
+These can be changed by active admin or your backend itself.
+
+## ToDo Features
+
+
+## Getting Help
+
+Got a bug and you're not sure? You're sure you have a bug, but don't know what to do next? In any case, let us know about it! The best place for letting the Contributes know about bugs or problems you're having is on the page at GitHub.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fi_seo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/fi_seo/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the FiSeo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/fi_seo/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/controller/sitemap_controller.rb

@@ -0,0 +1,58 @@
+require 'xml-sitemap'
+require 'acts_as_seoable/helpers/sitemap_helper'
+
+class SitemapController < ApplicationController
+  extend ActionDispatch::Routing::UrlFor
+
+  def sitemap
+    FiSeo::create_sitemap_seo_records
+    class_names = ActiveRecord::Base.connection.tables.map do |model|
+      model
+    end
+
+    domain = 'www.domain.com'
+    domain = FiSeo.initialized_config.sitemap_host_url if FiSeo.initialized_config.sitemap_host_url.present?
+
+    @map = XmlSitemap::Map.new(domain) do |m|
+      SitemapSeo.where(status: true).each do |site_map_seo|
+        action = site_map_seo.sitemap_action
+        controller = site_map_seo.sitemap_controller
+        priority = site_map_seo.priority
+        period = site_map_seo.period
+        static = site_map_seo.static
+
+        if SitemapSeo.periods[period.to_sym] == 0
+          period_string = 'none'
+          period_sym = period_string.to_sym
+        else
+          period_sym = period.to_sym
+        end
+
+        if class_names.include? controller.pluralize
+          p = controller.capitalize.singularize.camelize
+          if Object.const_defined?(p) && (%w[destroy update create index new].exclude? action) && p.constantize.any? && !static
+            p.constantize.all.each do |record|
+              if (%w[new create index].include? action)
+                m.add(url_for(controller: controller, action: action, only_path: true),
+                      priority: priority, updated: Date.today, period: period_sym)
+              else
+                m.add(url_for(controller: controller, action: action, id: record.id, only_path: true),
+                      priority: priority, updated: Date.today, period: period_sym)
+              end
+            end
+          elsif %w[destroy update create].exclude? action
+            m.add(url_for(controller: controller, action: action, only_path: true),
+                  priority: priority, updated: Date.today, period: period_sym)
+          end
+        elsif %w[destroy update create].exclude? action
+          m.add(url_for(controller: controller, action: action, only_path: true),
+                priority: priority, updated: Date.today, period: period_sym)
+        end
+      end
+    end
+
+    respond_to do |format|
+      format.xml
+    end
+  end
+end

data/app/views/acts_as_seoable/_view_helper.html.arb

@@ -0,0 +1,31 @@
+if defined?(seoable)
+    unless seoable.nil?
+        if action.to_s == 'show' && seoable.present? && seoable.dynamic_seo.present?
+            panel 'Dynamic SEO Information' do
+                attributes_table_for seoable.dynamic_seo do
+                  row 'Title' do
+                    seoable.dynamic_seo.title
+                  end
+                  row 'Description' do
+                    seoable.dynamic_seo.description
+                  end
+                  row 'Keywords' do
+                    seoable.dynamic_seo.keywords
+                  end
+                end
+            end
+        elsif action.to_s == 'edit' && seoable.object.dynamic_seo.present?
+            seoable.inputs 'Dynamic SEO Information', for: [:dynamic_seo, seoable.object.dynamic_seo] do |dynamic_seo|
+                dynamic_seo.input :title
+                dynamic_seo.input :description
+                dynamic_seo.input :keywords
+            end
+        elsif action.to_s == 'new'
+            seoable.inputs 'Dynamic SEO Information', for: [:dynamic_seo, seoable.object.dynamic_seo || DynamicSeo.new] do |dynamic_seo|
+                dynamic_seo.input :title
+                dynamic_seo.input :description
+                dynamic_seo.input :keywords
+            end
+        end
+    end
+end

data/app/views/google_analytics/_acts_as_seoable.html.erb

@@ -0,0 +1,9 @@
+<script>
+  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+      m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+  })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
+
+  ga('create', '<%= GoogleAnalyticSeo.first.content %>', 'none');
+  ga('send', 'pageview');
+</script>

data/app/views/sitemap/sitemap.xml.erb

@@ -0,0 +1 @@
+<%= @map.render.html_safe %>

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "fi_seo"
+
+# 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(__FILE__)

data/bin/setup

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