seo_optimizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 415bd41bed30c7e261ee469383cc1384e07fe41bcd1ac7e0da7b08811e3875ac
+  data.tar.gz: d45bd5f93a75a9ba0758372c3d5cb26c1fd01be470097d494f614efe2e654163
+SHA512:
+  metadata.gz: e3ffb4b684021306c18991d6c35d6f024001f84f6f0b4225bf60b5fe91fcc6047c0ed168ae72ef229664ebf6c96bf9f5cb1bcd7a23eb2243ef93daf20e7fc986
+  data.tar.gz: bea7e285cdf9c260b748867a27ee1c104107543fe7892f9ff34ebe6b74fd38c78aa29f8302d198e26f54b9c9f3ba6c1d758f92c23a7cd1ee3d49e33f89c74dcd

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea/

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.7.1

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+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 ronan33720@hotmail.com. 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,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in seo_optimizer.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+gem 'sitemap_generator'

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    seo_optimizer (0.1.0)
+      sitemap_generator
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    builder (3.2.4)
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    sitemap_generator (6.1.2)
+      builder (~> 3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  seo_optimizer!
+  sitemap_generator
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Ronan Louarn
+
+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,166 @@
+# Seo Optimizer
+
+Seo Optimizer provides a set of helpers which guide you in SEO improvements.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seo_optimizer'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install seo_optimizer
+
+## Usage
+
+#### Sitemap.yml, robots.txt
+
+There is a generator and a task to create needed files that will be read by search engines robots.
+
+**1** - Setup (it add a new config variable in `application.rb`)
+
+```bash
+$ rails g seo_optimizer:setups
+```    
+**2** - Replace the default value of product_url in `application.rb`  
+
+```ruby
+config.sitemap_config_variable = {}
+config.sitemap_config_variable[:production_url] = 'https://YOUR-PRODUCTION-URL.com'
+```
+
+**3** - Generate robots files (this will create sitemap.yml, robots.txt routes/actions/views)
+
+```bash
+$ rails g seo_optimizer:robots_files
+```
+
+**4** - Edit sitemap generate task `lib/tasks/sitemap/generate.rake` to add your customs routes like resources CRUD 
+    routes etc, check the section below for more informations or check sitemap_generator 
+    doc (https://github.com/kjvarga/sitemap_generator).
+
+**5** - Generate the sitemap.xml
+```bash
+$ rails sitemap:generate
+```
+**Existing routes will be generated in sitemap by default.**
+
+Then you can check these urls: 
+
+robots.txt file: http://localhost:3000/robots.txt  
+sitemap.xml file: http://localhost:3000/sitemap.xml  
+
+_________________
+
+#### Model routes with slug:
+
+To add seo_slug field to a model, you can use the generator as shown below.
+
+**1** - Syntax:
+`rails g seo_optimizer:my_model field_1 field_2 3 4 5...`
+
+    $ rails generate seo_optimizer:user first_name last_name other_field
+    
+**2** - Migrate
+
+    $ rails db:migrate    
+    
+**3** - Override `to_param` method in your model to change your models links pattern
+
+````ruby
+class User < ApplicationRecord
+  ...
+  
+  def to_param
+    seo_slug
+  end
+end
+````
+
+And then `<%= link_to 'Show', User.first %>` will generate a link that follow the new seo pattern
+
+`/users/USERID-FIELD-FIELD-FIELD`
+
+
+`/users/1-field_one-field_two-other_field`
+
+
+**4** - So, in your `UsersController`:
+
+```ruby
+class UsersController < ApplicationController
+  before_action :set_user, only: :show
+  
+  def show; end
+
+  private
+
+  def set_user
+    # we find users by seo_slug field 
+    @user = User.find_by(seo_slug: params[:id])
+  end
+end
+```
+
+**5** - You can update the sitemap task to add every routes with slugs in it.
+
+- In `SitemapGenerator::Sitemap.create` block
+
+```ruby
+SitemapGenerator::Sitemap.create do
+  ...
+  User.select(:seo_slug, :updated_at).each do |slug|
+    add user_path(slug), lastmod: slug.updated_at, priority: 0.8
+  end
+end
+```
+
+- Then don't forget to `$ rails sitemap:generate`.
+
+______________
+
+#### Error pages (404, 500):
+ 
+**1** - Generate error pages view, actions and routes.
+```bash
+$ rails g seo_optimizer:errors_pages
+```
+
+**2** - You can customize pages in `app/views/errors/`
+
+**3** - Edit `config/environment/develoment.rb` if you want to test it in dev environment.
+
+⛔️ DO NOT COMMIT ⛔️
+
+```ruby
+config.consider_all_requests_local = true
+# to 
+config.consider_all_requests_local = false 
+```
+_________________
+ 
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/seo_optimizer. 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]/seo_optimizer/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 SeoOptimizer project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/seo_optimizer/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/bin/console

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

data/lib/generators/seo_optimizer/errors_pages/errors_pages_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+
+module SeoOptimizer
+  class ErrorsPagesGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Generates errors pages'
+
+    def create_controller_files
+      route %(get '/500' => 'errors#internal_server_error'\nget '/404' => 'errors#not_found'\n)
+
+      inject_into_file 'config/application.rb', :before => "  end" do
+        "\n    config.exceptions_app = self.routes\n"
+      end
+      %x(rm -f public/404.html)
+      %x(rm -f public/500.html)
+      template 'errors_controller_template.erb', File.join('app/controllers', 'errors_controller.rb')
+      template '404.erb', File.join('app/views/errors', 'not_found.html.erb')
+      template '500.erb', File.join('app/views/errors', 'internal_server_error.html.erb')
+    end
+  end
+end

data/lib/generators/seo_optimizer/errors_pages/templates/404.erb

@@ -0,0 +1,231 @@
+<div class="background">
+  <div class="ground"></div>
+</div>
+<div class="container">
+  <div class="left-section">
+    <div class="inner-content">
+      <h1 class="heading">404</h1>
+      <p class="subheading">Looks like the page you were looking for is no longer here.</p>
+    </div>
+  </div>
+  <div class="right-section">
+    <svg class="svgimg" xmlns="http://www.w3.org/2000/svg" viewBox="51.5 -15.288 385 505.565">
+      <g class="bench-legs">
+        <path d="M202.778,391.666h11.111v98.611h-11.111V391.666z M370.833,390.277h11.111v100h-11.111V390.277z M183.333,456.944h11.111
+          v33.333h-11.111V456.944z M393.056,456.944h11.111v33.333h-11.111V456.944z" />
+      </g>
+      <g class="top-bench">
+        <path d="M396.527,397.917c0,1.534-1.243,2.777-2.777,2.777H190.972c-1.534,0-2.778-1.243-2.778-2.777v-8.333
+          c0-1.535,1.244-2.778,2.778-2.778H393.75c1.534,0,2.777,1.243,2.777,2.778V397.917z M400.694,414.583
+          c0,1.534-1.243,2.778-2.777,2.778H188.194c-1.534,0-2.778-1.244-2.778-2.778v-8.333c0-1.534,1.244-2.777,2.778-2.777h209.723
+          c1.534,0,2.777,1.243,2.777,2.777V414.583z M403.473,431.25c0,1.534-1.244,2.777-2.778,2.777H184.028
+          c-1.534,0-2.778-1.243-2.778-2.777v-8.333c0-1.534,1.244-2.778,2.778-2.778h216.667c1.534,0,2.778,1.244,2.778,2.778V431.25z"
+          />
+      </g>
+      <g class="bottom-bench">
+        <path d="M417.361,459.027c0,0.769-1.244,1.39-2.778,1.39H170.139c-1.533,0-2.777-0.621-2.777-1.39v-4.86
+          c0-0.769,1.244-0.694,2.777-0.694h244.444c1.534,0,2.778-0.074,2.778,0.694V459.027z" />
+        <path d="M185.417,443.75H400c0,0,18.143,9.721,17.361,10.417l-250-0.696C167.303,451.65,185.417,443.75,185.417,443.75z" />
+      </g>
+      <g id="lamp">
+        <path class="lamp-details" d="M125.694,421.997c0,1.257-0.73,3.697-1.633,3.697H113.44c-0.903,0-1.633-2.44-1.633-3.697V84.917
+          c0-1.257,0.73-2.278,1.633-2.278h10.621c0.903,0,1.633,1.02,1.633,2.278V421.997z"
+          />
+        <path class="lamp-accent" d="M128.472,93.75c0,1.534-1.244,2.778-2.778,2.778h-13.889c-1.534,0-2.778-1.244-2.778-2.778V79.861
+          c0-1.534,1.244-2.778,2.778-2.778h13.889c1.534,0,2.778,1.244,2.778,2.778V93.75z" />
+
+        <circle class="lamp-light" cx="119.676" cy="44.22" r="40.51" />
+        <path class="lamp-details" d="M149.306,71.528c0,3.242-13.37,13.889-29.861,13.889S89.583,75.232,89.583,71.528c0-4.166,13.369-13.889,29.861-13.889
+          S149.306,67.362,149.306,71.528z"/>
+        <radialGradient class="light-gradient" id="SVGID_1_" cx="119.676" cy="44.22" r="65" gradientUnits="userSpaceOnUse">
+          <stop  offset="0%" style="stop-color:#FFFFFF; stop-opacity: 1"/>
+          <stop  offset="50%" style="stop-color:#EDEDED; stop-opacity: 0.5">
+            <animate attributeName="stop-opacity" values="0.0; 0.5; 0.0" dur="5000ms" repeatCount="indefinite"></animate>
+          </stop>
+          <stop  offset="100%" style="stop-color:#EDEDED; stop-opacity: 0"/>
+        </radialGradient>
+        <circle class="lamp-light__glow" fill="url(#SVGID_1_)" cx="119.676" cy="44.22" r="65"/>
+        <path class="lamp-bottom" d="M135.417,487.781c0,1.378-1.244,2.496-2.778,2.496H106.25c-1.534,0-2.778-1.118-2.778-2.496v-74.869
+          c0-1.378,1.244-2.495,2.778-2.495h26.389c1.534,0,2.778,1.117,2.778,2.495V487.781z" />
+      </g>
+    </svg>
+  </div>
+</div>
+
+<style>
+  @import url("https://fonts.googleapis.com/css?family=Fira+Sans");
+  /*Variables */
+  .left-section .inner-content {
+    position: absolute;
+    top: 50%;
+    transform: translateY(-50%);
+  }
+
+  * {
+    box-sizing: border-box;
+  }
+
+  html, body {
+    margin: 0;
+    padding: 0;
+  }
+
+  body {
+    font-family: "Fira Sans", sans-serif;
+    color: #f5f6fa;
+  }
+
+  .background {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    background: linear-gradient(#0C0E10, #446182);
+  }
+  .background .ground {
+    position: absolute;
+    bottom: 0;
+    width: 100%;
+    height: 25vh;
+    background: #0C0E10;
+  }
+  @media (max-width: 770px) {
+    .background .ground {
+      height: 0vh;
+    }
+  }
+
+  .container {
+    position: relative;
+    margin: 0 auto;
+    width: 85%;
+    height: 100vh;
+    padding-bottom: 25vh;
+    display: flex;
+    flex-direction: row;
+    justify-content: space-around;
+  }
+  @media (max-width: 770px) {
+    .container {
+      flex-direction: column;
+      padding-bottom: 0vh;
+    }
+  }
+
+  .left-section, .right-section {
+    position: relative;
+  }
+
+  .left-section {
+    width: 40%;
+  }
+  @media (max-width: 770px) {
+    .left-section {
+      width: 100%;
+      height: 40%;
+      position: absolute;
+      top: 0;
+    }
+  }
+  @media (max-width: 770px) {
+    .left-section .inner-content {
+      position: relative;
+      padding: 1rem 0;
+    }
+  }
+
+  .heading {
+    text-align: center;
+    font-size: 9em;
+    line-height: 1.3em;
+    margin: 2rem 0 0.5rem 0;
+    padding: 0;
+    text-shadow: 0 0 1rem #fefefe;
+  }
+  @media (max-width: 770px) {
+    .heading {
+      font-size: 7em;
+      line-height: 1.15;
+      margin: 0;
+    }
+  }
+
+  .subheading {
+    text-align: center;
+    max-width: 480px;
+    font-size: 1.5em;
+    line-height: 1.15em;
+    padding: 0 1rem;
+    margin: 0 auto;
+  }
+  @media (max-width: 770px) {
+    .subheading {
+      font-size: 1.3em;
+      line-height: 1.15;
+      max-width: 100%;
+    }
+  }
+
+  .right-section {
+    width: 50%;
+  }
+  @media (max-width: 770px) {
+    .right-section {
+      width: 100%;
+      height: 60%;
+      position: absolute;
+      bottom: 0;
+    }
+  }
+
+  .svgimg {
+    position: absolute;
+    bottom: 0;
+    padding-top: 10vh;
+    padding-left: 1vh;
+    max-width: 100%;
+    max-height: 100%;
+  }
+  @media (max-width: 770px) {
+    .svgimg {
+      padding: 0;
+    }
+  }
+  .svgimg .bench-legs {
+    fill: #0C0E10;
+  }
+  .svgimg .top-bench, .svgimg .bottom-bench {
+    stroke: #0C0E10;
+    stroke-width: 1px;
+    fill: #5B3E2B;
+  }
+  .svgimg .bottom-bench path:nth-child(1) {
+    fill: #432d20;
+  }
+  .svgimg .lamp-details {
+    fill: #202425;
+  }
+  .svgimg .lamp-accent {
+    fill: #2c3133;
+  }
+  .svgimg .lamp-bottom {
+    fill: linear-gradient(#202425, #0C0E10);
+  }
+  .svgimg .lamp-light {
+    fill: #EFEFEF;
+  }
+
+  @keyframes glow {
+    0% {
+      text-shadow: 0 0 1rem #fefefe;
+    }
+    50% {
+      text-shadow: 0 0 1.85rem #ededed;
+    }
+    100% {
+      text-shadow: 0 0 1rem #fefefe;
+    }
+  }
+
+</style>

data/lib/generators/seo_optimizer/errors_pages/templates/500.erb

@@ -0,0 +1,231 @@
+<div class="background">
+  <div class="ground"></div>
+</div>
+<div class="container">
+  <div class="left-section">
+    <div class="inner-content">
+      <h1 class="heading">500</h1>
+      <p class="subheading">Looks like the page you were looking for is no longer here.</p>
+    </div>
+  </div>
+  <div class="right-section">
+    <svg class="svgimg" xmlns="http://www.w3.org/2000/svg" viewBox="51.5 -15.288 385 505.565">
+      <g class="bench-legs">
+        <path d="M202.778,391.666h11.111v98.611h-11.111V391.666z M370.833,390.277h11.111v100h-11.111V390.277z M183.333,456.944h11.111
+          v33.333h-11.111V456.944z M393.056,456.944h11.111v33.333h-11.111V456.944z" />
+      </g>
+      <g class="top-bench">
+        <path d="M396.527,397.917c0,1.534-1.243,2.777-2.777,2.777H190.972c-1.534,0-2.778-1.243-2.778-2.777v-8.333
+          c0-1.535,1.244-2.778,2.778-2.778H393.75c1.534,0,2.777,1.243,2.777,2.778V397.917z M400.694,414.583
+          c0,1.534-1.243,2.778-2.777,2.778H188.194c-1.534,0-2.778-1.244-2.778-2.778v-8.333c0-1.534,1.244-2.777,2.778-2.777h209.723
+          c1.534,0,2.777,1.243,2.777,2.777V414.583z M403.473,431.25c0,1.534-1.244,2.777-2.778,2.777H184.028
+          c-1.534,0-2.778-1.243-2.778-2.777v-8.333c0-1.534,1.244-2.778,2.778-2.778h216.667c1.534,0,2.778,1.244,2.778,2.778V431.25z"
+          />
+      </g>
+      <g class="bottom-bench">
+        <path d="M417.361,459.027c0,0.769-1.244,1.39-2.778,1.39H170.139c-1.533,0-2.777-0.621-2.777-1.39v-4.86
+          c0-0.769,1.244-0.694,2.777-0.694h244.444c1.534,0,2.778-0.074,2.778,0.694V459.027z" />
+        <path d="M185.417,443.75H400c0,0,18.143,9.721,17.361,10.417l-250-0.696C167.303,451.65,185.417,443.75,185.417,443.75z" />
+      </g>
+      <g id="lamp">
+        <path class="lamp-details" d="M125.694,421.997c0,1.257-0.73,3.697-1.633,3.697H113.44c-0.903,0-1.633-2.44-1.633-3.697V84.917
+          c0-1.257,0.73-2.278,1.633-2.278h10.621c0.903,0,1.633,1.02,1.633,2.278V421.997z"
+          />
+        <path class="lamp-accent" d="M128.472,93.75c0,1.534-1.244,2.778-2.778,2.778h-13.889c-1.534,0-2.778-1.244-2.778-2.778V79.861
+          c0-1.534,1.244-2.778,2.778-2.778h13.889c1.534,0,2.778,1.244,2.778,2.778V93.75z" />
+
+        <circle class="lamp-light" cx="119.676" cy="44.22" r="40.51" />
+        <path class="lamp-details" d="M149.306,71.528c0,3.242-13.37,13.889-29.861,13.889S89.583,75.232,89.583,71.528c0-4.166,13.369-13.889,29.861-13.889
+          S149.306,67.362,149.306,71.528z"/>
+        <radialGradient class="light-gradient" id="SVGID_1_" cx="119.676" cy="44.22" r="65" gradientUnits="userSpaceOnUse">
+          <stop  offset="0%" style="stop-color:#FFFFFF; stop-opacity: 1"/>
+          <stop  offset="50%" style="stop-color:#EDEDED; stop-opacity: 0.5">
+            <animate attributeName="stop-opacity" values="0.0; 0.5; 0.0" dur="5000ms" repeatCount="indefinite"></animate>
+          </stop>
+          <stop  offset="100%" style="stop-color:#EDEDED; stop-opacity: 0"/>
+        </radialGradient>
+        <circle class="lamp-light__glow" fill="url(#SVGID_1_)" cx="119.676" cy="44.22" r="65"/>
+        <path class="lamp-bottom" d="M135.417,487.781c0,1.378-1.244,2.496-2.778,2.496H106.25c-1.534,0-2.778-1.118-2.778-2.496v-74.869
+          c0-1.378,1.244-2.495,2.778-2.495h26.389c1.534,0,2.778,1.117,2.778,2.495V487.781z" />
+      </g>
+    </svg>
+  </div>
+</div>
+
+<style>
+  @import url("https://fonts.googleapis.com/css?family=Fira+Sans");
+  /*Variables */
+  .left-section .inner-content {
+    position: absolute;
+    top: 50%;
+    transform: translateY(-50%);
+  }
+
+  * {
+    box-sizing: border-box;
+  }
+
+  html, body {
+    margin: 0;
+    padding: 0;
+  }
+
+  body {
+    font-family: "Fira Sans", sans-serif;
+    color: #f5f6fa;
+  }
+
+  .background {
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    background: linear-gradient(#0C0E10, #446182);
+  }
+  .background .ground {
+    position: absolute;
+    bottom: 0;
+    width: 100%;
+    height: 25vh;
+    background: #0C0E10;
+  }
+  @media (max-width: 770px) {
+    .background .ground {
+      height: 0vh;
+    }
+  }
+
+  .container {
+    position: relative;
+    margin: 0 auto;
+    width: 85%;
+    height: 100vh;
+    padding-bottom: 25vh;
+    display: flex;
+    flex-direction: row;
+    justify-content: space-around;
+  }
+  @media (max-width: 770px) {
+    .container {
+      flex-direction: column;
+      padding-bottom: 0vh;
+    }
+  }
+
+  .left-section, .right-section {
+    position: relative;
+  }
+
+  .left-section {
+    width: 40%;
+  }
+  @media (max-width: 770px) {
+    .left-section {
+      width: 100%;
+      height: 40%;
+      position: absolute;
+      top: 0;
+    }
+  }
+  @media (max-width: 770px) {
+    .left-section .inner-content {
+      position: relative;
+      padding: 1rem 0;
+    }
+  }
+
+  .heading {
+    text-align: center;
+    font-size: 9em;
+    line-height: 1.3em;
+    margin: 2rem 0 0.5rem 0;
+    padding: 0;
+    text-shadow: 0 0 1rem #fefefe;
+  }
+  @media (max-width: 770px) {
+    .heading {
+      font-size: 7em;
+      line-height: 1.15;
+      margin: 0;
+    }
+  }
+
+  .subheading {
+    text-align: center;
+    max-width: 480px;
+    font-size: 1.5em;
+    line-height: 1.15em;
+    padding: 0 1rem;
+    margin: 0 auto;
+  }
+  @media (max-width: 770px) {
+    .subheading {
+      font-size: 1.3em;
+      line-height: 1.15;
+      max-width: 100%;
+    }
+  }
+
+  .right-section {
+    width: 50%;
+  }
+  @media (max-width: 770px) {
+    .right-section {
+      width: 100%;
+      height: 60%;
+      position: absolute;
+      bottom: 0;
+    }
+  }
+
+  .svgimg {
+    position: absolute;
+    bottom: 0;
+    padding-top: 10vh;
+    padding-left: 1vh;
+    max-width: 100%;
+    max-height: 100%;
+  }
+  @media (max-width: 770px) {
+    .svgimg {
+      padding: 0;
+    }
+  }
+  .svgimg .bench-legs {
+    fill: #0C0E10;
+  }
+  .svgimg .top-bench, .svgimg .bottom-bench {
+    stroke: #0C0E10;
+    stroke-width: 1px;
+    fill: #5B3E2B;
+  }
+  .svgimg .bottom-bench path:nth-child(1) {
+    fill: #432d20;
+  }
+  .svgimg .lamp-details {
+    fill: #202425;
+  }
+  .svgimg .lamp-accent {
+    fill: #2c3133;
+  }
+  .svgimg .lamp-bottom {
+    fill: linear-gradient(#202425, #0C0E10);
+  }
+  .svgimg .lamp-light {
+    fill: #EFEFEF;
+  }
+
+  @keyframes glow {
+    0% {
+      text-shadow: 0 0 1rem #fefefe;
+    }
+    50% {
+      text-shadow: 0 0 1.85rem #ededed;
+    }
+    100% {
+      text-shadow: 0 0 1rem #fefefe;
+    }
+  }
+
+</style>

data/lib/generators/seo_optimizer/errors_pages/templates/errors_controller_template.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class ErrorsController < ApplicationController
+  def not_found
+    render(status: 404)
+  end
+
+  def internal_server_error
+    render(status: 500)
+  end
+end

data/lib/generators/seo_optimizer/models/models_generator.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+
+module SeoOptimizer
+  class ModelsGenerator < Rails::Generators::NamedBase
+    source_root File.expand_path('templates', __dir__)
+    include Rails::Generators::Migration
+    desc 'Generates migration for models'
+
+    argument :desired_fields, type: :array, default: [], banner: "field field"
+
+    def self.orm
+      Rails::Generators.options[:rails][:orm]
+    end
+
+    def self.orm_has_migration?
+      [:active_record].include? orm
+    end
+
+    def self.next_migration_number(_path)
+      Time.now.utc.strftime('%Y%m%d%H%M%S')
+    end
+
+    def create_migration_file
+      return unless self.class.orm_has_migration?
+
+      migration_template 'model_template.erb',
+                         "db/migrate/add_#{model_name}_seo_slug_migration.rb",
+                         migration_version: migration_version,
+                         model_name: model_name,
+                         model_table: model_table,
+                         desired_fields_reference: desired_fields_reference
+
+    end
+
+    private
+
+    def model
+      name
+    end
+
+    def model_name
+      model.downcase
+    end
+
+    def model_table
+      model_name.pluralize(2)
+    end
+
+    def desired_fields_reference
+      desired_fields.delete('seo_slug')
+      desired_fields.join(', ')
+    end
+
+    def migration_version
+      if rails5?
+        '[4.2]'
+      elsif rails6?
+        '[6.0]'
+      end
+    end
+
+    def rails5?
+      Rails.version.start_with? '5'
+    end
+
+    def rails6?
+      Rails.version.start_with? '6'
+    end
+  end
+end

data/lib/generators/seo_optimizer/models/templates/model_template.erb

@@ -0,0 +1,19 @@
+class Add<%= model_name.capitalize %>SeoSlugMigration < ActiveRecord::Migration<%= migration_version %>
+  def up
+    add_column(:<%= model_table %>, :seo_slug, :string) unless column_exists?(:<%= model_table %>, :seo_slug)
+    ActiveRecord::Base.connection.execute(query)
+  end
+
+  def down
+    remove_column :<%= model_table %>, :seo_slug
+  end
+
+  private
+
+  def query
+    <<-SQL
+      UPDATE <%= model_table %>
+      SET seo_slug = concat_ws('-', id, <%= desired_fields_reference %>)
+    SQL
+  end
+end

data/lib/generators/seo_optimizer/robots_files/robots_files_generator.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+
+module SeoOptimizer
+  class RobotsFilesGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Generates robots files'
+
+    def create_controller_files
+      prod_variable = Rails.configuration.sitemap_config_variable rescue raise(SeoOptimizer::Error, setup_error_message)
+      url = prod_variable[:production_url]
+      raise SeoOptimizer::Error, replace_url_error if !url || url == 'https://YOUR-PRODUCTION-URL.com'
+
+      site_map_xml
+      robots_text
+    end
+
+    private
+
+    def robots_text
+      routing_code = %(get 'robots.:format', to: 'robots#show')
+      route routing_code
+      %x(rm -f public/robots.txt)
+      template 'robots_controller_template.erb', File.join('app/controllers', 'robots_controller.rb')
+      %x(mkdir -p app/views/robots)
+      template 'robots_show_template.erb', File.join('app/views/robots', 'show.txt.erb')
+    end
+
+    def site_map_xml
+      routing_code = %(get 'sitemap.xml', to: 'sitemaps#show', as: :sitemap, defaults: { format: :xml })
+      route routing_code
+      template 'sitemaps_controller_template.erb', File.join('app/controllers', 'sitemaps_controller.rb')
+      template 'sitemaps_task_template.erb', File.join('lib/tasks/sitemap', 'generate.rake')
+    end
+
+    def replace_url_error
+      '
+        Please replace https://YOUR-PRODUCTION-URL.com by your production url in application.rb,
+        check the doc https://github.com/RonanLOUARN/seo_optimizer for more infos.
+      '
+    end
+
+    def setup_error_message
+      '
+        Please type "rails generate seo_optimizer:setups" in terminal,
+        check the doc https://github.com/RonanLOUARN/seo_optimizer for more infos.
+      '
+    end
+  end
+end

data/lib/generators/seo_optimizer/robots_files/templates/robots_controller_template.erb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class RobotsController < ApplicationController
+  def show
+    respond_to do |format|
+      format.text do
+        render 'robots/show.txt.erb'
+      end
+    end
+  end
+end

data/lib/generators/seo_optimizer/robots_files/templates/robots_show_template.erb

@@ -0,0 +1,3 @@
+User-Agent: *
+Disallow: /admin
+Sitemap: <%= Rails.configuration.sitemap_config_variable[:production_url]  %>/sitemap.xml

data/lib/generators/seo_optimizer/robots_files/templates/sitemaps_controller_template.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class SitemapsController < ApplicationController
+  def show
+    file = Zlib::GzipReader.new(open('public/sitemap.xml.gz'))
+    render xml: file.read
+  end
+end

data/lib/generators/seo_optimizer/robots_files/templates/sitemaps_task_template.erb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+namespace :sitemap do
+  task generate: :environment do
+    SitemapGenerator::Sitemap.default_host = '<%= Rails.configuration.sitemap_config_variable[:production_url] %>'
+    SitemapGenerator::Sitemap.create_index = false
+    SitemapGenerator::Sitemap.create do
+      routes = Rails.application.routes.routes.map do |route|
+        {
+          alias: route.name,
+          path: route.path.spec.to_s,
+          controller: route.defaults[:controller],
+          action: route.defaults[:action],
+        }
+      end
+
+      # Set a list of controllers you don't want to generate routes for.
+      # /rails/info in particular maps to something inaccessible.
+      # redirects have a nil controller. This prevents duplicate content penalties.
+      banned_controllers = ["rails/info", nil]
+      routes.reject! { |route| banned_controllers.include?(route[:controller]) }
+
+      # sitemap_generator includes root by default; prevent duplication
+      routes.reject! { |route| route[:path] == '/' }
+
+      routes.each { |route| add route[:path][0..-11] } # Strips off '(.:format)
+
+      # Notice the below if you're hosting Jekyll/Octopress in a subdirectory
+      # or otherwise want to index content outside of Rails' routes.
+      # add_to_index '/sitemaps/show.xml'
+
+      # example for user resources
+      # User.select(:seo_slug, :updated_at).each do |slug|
+      #   add user_path(slug), lastmod: slug.updated_at
+      # end
+    end
+    SitemapGenerator::Sitemap.ping_search_engines('<%= Rails.configuration.sitemap_config_variable[:production_url] %>/sitemap.xml')
+  end
+end

data/lib/generators/seo_optimizer/setups/setups_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'rails/generators/migration'
+
+module SeoOptimizer
+  class SetupsGenerator < Rails::Generators::Base
+    source_root File.expand_path('templates', __dir__)
+    desc 'Generates setup lines'
+
+    def create_controller_files
+      Rails.configuration.sitemap_config_variable
+    rescue
+      inject_into_file 'config/application.rb', :before => "  end" do
+        "\n    config.sitemap_config_variable = {}" +
+          "\n    config.sitemap_config_variable[:production_url] = 'https://YOUR-PRODUCTION-URL.com'\n\n"
+      end
+    end
+  end
+end

data/lib/seo_optimizer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'seo_optimizer/version'
+require 'sitemap_generator'
+
+class SeoOptimizer::Error < StandardError; end

data/lib/seo_optimizer/version.rb

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

data/seo_optimizer.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative 'lib/seo_optimizer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "seo_optimizer"
+  spec.version       = SeoOptimizer::VERSION
+  spec.authors       = ["Ronan Louarn"]
+  spec.email         = ["ronan33720@hotmail.com"]
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.summary       = %q{Simple gem to improve SEO to your rails app.}
+  spec.description   = %q{Simple gem to improve SEO to your rails app.}
+  spec.homepage      = "https://www.lr-dev.fr"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/RonanLOUARN/seo_optimizer"
+  spec.metadata["changelog_uri"] = "https://github.com/RonanLOUARN/seo_optimizer/commits/master"
+
+  # 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_dependency 'sitemap_generator'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: seo_optimizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronan Louarn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-11-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sitemap_generator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple gem to improve SEO to your rails app.
+email:
+- ronan33720@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/generators/seo_optimizer/errors_pages/errors_pages_generator.rb
+- lib/generators/seo_optimizer/errors_pages/templates/404.erb
+- lib/generators/seo_optimizer/errors_pages/templates/500.erb
+- lib/generators/seo_optimizer/errors_pages/templates/errors_controller_template.erb
+- lib/generators/seo_optimizer/models/models_generator.rb
+- lib/generators/seo_optimizer/models/templates/model_template.erb
+- lib/generators/seo_optimizer/robots_files/robots_files_generator.rb
+- lib/generators/seo_optimizer/robots_files/templates/robots_controller_template.erb
+- lib/generators/seo_optimizer/robots_files/templates/robots_show_template.erb
+- lib/generators/seo_optimizer/robots_files/templates/sitemaps_controller_template.erb
+- lib/generators/seo_optimizer/robots_files/templates/sitemaps_task_template.erb
+- lib/generators/seo_optimizer/setups/setups_generator.rb
+- lib/seo_optimizer.rb
+- lib/seo_optimizer/version.rb
+- seo_optimizer.gemspec
+homepage: https://www.lr-dev.fr
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://www.lr-dev.fr
+  source_code_uri: https://github.com/RonanLOUARN/seo_optimizer
+  changelog_uri: https://github.com/RonanLOUARN/seo_optimizer/commits/master
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple gem to improve SEO to your rails app.
+test_files: []