para-seo_tools 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 221bb39c998483d4271625e92a0ae8a99e60892d
+  data.tar.gz: 1f98d09e9135f026442dbda3f64dfeb300c1abf8
+SHA512:
+  metadata.gz: 28d2a040ebdc391c3ae165489e2aa190560b43a84fa200bf689d6e1bcd511639762b7d59eb117828d0b5addfe6f06f355d01f07cc664353d1d336432d8ea14f0
+  data.tar.gz: 375e465165815264dc4b89a61afdc6097e7a6ba7941ff5173bf088f4e189b62f324cc38ae0f13712004b7d1d405b73529320fbb12570b21c7a602dcdffbeca6d

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 vala
+
+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,178 @@
+# Para::SeoTools
+
+The SEO Tools for Para allows to configure the sitemap and meta tags for your
+Para CMS powered website.
+
+You'll be able to easily define a sitemap for your app, and get an admin panel
+for filling out all the pages' meta tags.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'seo_tools-para'
+```
+
+And then execute:
+
+```bash
+bundle
+```
+
+Or install it yourself as:
+
+```bash
+gem install seo_tools-para
+```
+
+Run the installation generator :
+
+```bash
+rails generate seo_tools:install
+```
+
+## Usage
+
+The idea is to define a simple Sitemap structure, and you'll be able to
+edit those pages meta_tags from the admin panel, and a sitemap.xml will be
+generatable with a simple Task.
+
+In the following section, you'll find how to :
+
+1. Define the sitemap
+2. Display the meta tags admin panel
+3. Generate a sitemap.xml
+4. Retrieving meta tags in your app
+
+
+### 1. Define the sitemap
+
+When you run the `seo_tools:install` generator, a file is created at
+`config/skeleton.rb` for you to create the sitemap.
+
+This file allows you to define which pages you want to make available for
+search engines indexation and optimization, through a simple DSL.
+
+The pages are defined with the `page` method, and accepts some options.
+
+The following will define the page `posts` and call `posts_path` to retrieve
+its URL
+
+```ruby
+page :posts
+```
+
+If you want to define the page path yourself, just add the `:path` option
+to the `page` call
+
+```ruby
+page :home, path: root_path
+```
+
+When the page is linked to a resource : often, a #show page, you'll need to
+pass the `:resource` option
+
+```ruby
+Posts.find_each do |post|
+  page :post, resource: post
+end
+```
+
+Also, you can pass options for the sitemap generation tool.
+The options are `:priority`, `:change_frequency` which are left blank
+by default.
+
+```ruby
+page :posts, priority: 1, change_frequency: 'weekly'
+```
+
+### 2. Display the meta tags admin panel
+
+For the admin panel to display, all you'll need to do is create the component
+in your Para's `components.rb`.
+
+> Note : For more informations on the `components.rb` file, please see the
+> [Para documentation](https://github.com/para-cms/para/wiki/Components-configuration)
+
+Add the component to your `config/components.rb` file :
+
+```ruby
+section :your_section do
+  component :sitemap, :seo_tools_skeleton
+end
+```
+
+The go to the admin panel, and click the **Sitemap** menu link.
+
+### 3. Generate a sitemap.xml
+
+Sitemap generation is accomplished through the use of the
+[rails-sitemap](https://github.com/viseztrance/rails-sitemap) gem,
+with a custom task to integrate easily with `seo_tools-para`.
+
+You'll first need to configure your application's host name.
+This can be defined in the generated initializer or in an environment variable.
+
+In the `config/initializers/seo_tools.rb` initializer :
+
+```ruby
+config.host = "www.mydomain.com"
+```
+
+Or with the `APP_DOMAIN` environment variable.
+
+```bash
+APP_DOMAIN="www.mydomain.com"
+```
+
+Generating the sitemap can be done with the dedicated rake task :
+
+```bash
+rake seo_tools:sitemap:generate
+```
+
+You can pass a `LOCATION` environment variable to define where to store it.
+By default, it will be stored at : `public/sitemap.xml`
+
+```bash
+rake seo_tools:sitemap:generate LOCATION=/home/user/apps/my-app/shared
+```
+
+### 4. Retrieving meta tags in your app
+
+Meta tags edition and rendering is done through the
+[meta_tags](https://github.com/glyph-fr/meta_tags) gem.
+
+For more informations on customizing its behavior, please see the
+[meta_tags documentation](https://github.com/glyph-fr/meta_tags).
+
+The meta tags are automatically retrieved from the current page path by default.
+
+`seo_tools-para` includes a `before_action` callback that fetches the existing
+meta tags for the current path, and sets them in your page.
+
+All you need to do is to include the following in your layout file, at the top
+of your `<head>` tag, since `meta_tags` automatically appends the
+`<meta encoding="utf-8">` tag.
+
+```erb
+<html>
+  <head>
+    <%= meta_tags %>
+    ...
+  </head>
+  <body>
+    ...
+  </body>
+</html>
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/seo_tools-para/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/app/components/seo_tools_skeleton_component.rb

@@ -0,0 +1,7 @@
+class SeoToolsSkeletonComponent < Para::Component::Crud
+  register :seo_tools_skeleton, self
+
+  def model_type
+    '::Para::SeoTools::Page'
+  end
+end

data/app/controllers/admin/para/seo_tools/skeleton_resources_controller.rb

@@ -0,0 +1,21 @@
+module Admin
+  module Para
+    module SeoTools
+      class SkeletonResourcesController < ::Para::Admin::CrudResourcesController
+        def index
+          super
+          @available_locales = ::Para::SeoTools::Page.group(:locale).pluck(:locale)
+        end
+
+        def refresh
+          ::Para::SeoTools::Skeleton.with_logging do
+            ::Para::SeoTools::Skeleton.load
+            ::Para::SeoTools::Skeleton::Worker.perform
+          end
+
+          redirect_to after_form_submit_path
+        end
+      end
+    end
+  end
+end

data/app/decorators/seo_tools_skeleton_component_decorator.rb

@@ -0,0 +1,3 @@
+module SeoToolsSkeletonComponentDecorator
+  include Para::Component::CrudDecorator
+end

data/app/helpers/para/seo_tools/admin/fields_helper.rb

@@ -0,0 +1,15 @@
+module Para
+  module SeoTools
+    module Admin
+      module FieldsHelper
+        def meta_tag_input(form, name, options = {})
+          options[:hint] ||= if (default = form.object.default(name))
+            t('para.seo_tools.pages.default_meta_tag_value', value: default).html_safe
+          end
+
+          form.input name, options
+        end
+      end
+    end
+  end
+end

data/app/models/para/seo_tools/page.rb

@@ -0,0 +1,54 @@
+module Para
+  module SeoTools
+    class Page < ActiveRecord::Base
+      META_TAGS = :title, :description, :keywords, :image, :canonical
+
+      has_attached_file :image, styles: { thumb: '200x200#' }
+      validates_attachment :image, content_type: { content_type: /\Aimage\/.*\Z/ }
+
+      def meta_tag(name)
+        process(name, send(name)).presence || default(name)
+      end
+
+      def defaults
+        if (hash = read_attribute(:defaults))
+          hash
+        else
+          self.defaults = {}
+        end
+      end
+
+      def default(name)
+        process(name, defaults[name.to_s]) if defaults[name.to_s]
+      end
+
+      ransacker :title do |parent|
+        default_title = Arel::Nodes::InfixOperation.new('->>', parent.table[:defaults], Arel::Nodes.build_quoted('title'))
+        expr = Arel::Nodes::NamedFunction.new('COALESCE', [parent.table[:title], default_title])
+
+        # Conversion to Arel::Nodes::SqlLiteral is required for sorting to work,
+        # since the Arel::Nodes::NamedFunction doesn't include Arel ordering
+        # methods, and Ransack uses them
+        #
+        Arel::Nodes::SqlLiteral.new(expr.to_sql)
+      end
+
+      ransacker :description do |parent|
+        default_description = Arel::Nodes::InfixOperation.new('->>', parent.table[:defaults], Arel::Nodes.build_quoted('description'))
+        expr = Arel::Nodes::NamedFunction.new('COALESCE',[parent.table[:description], default_description])
+
+        Arel::Nodes::SqlLiteral.new(expr.to_sql)
+      end
+
+      private
+
+      def process(name, value)
+        if (processor = Para::SeoTools::MetaTags::Tags[name])
+          processor.process(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/app/views/admin/para/seo_tools/pages/_actions.html.haml

@@ -0,0 +1,5 @@
+%ul.panel-controls
+  %li
+    = link_to @component.relation_path(action: :refresh, return_to: request.fullpath), class: 'btn btn-default' do
+      = fa_icon 'refresh'
+      = t('para.seo_tools.pages.refresh_skeleton')

data/app/views/admin/para/seo_tools/pages/_filters.html.haml

@@ -0,0 +1,25 @@
+= search_form_for @q, builder: SimpleForm::FormBuilder, url: @component.path, html: { data: { :'filters-form' => true } } do |form|
+  - if @available_locales.length > 1
+    .row
+      .col-md-3
+        = form.input_field :locale_eq, as: :selectize, collection: @available_locales, class: 'form-control', placeholder: t('para.seo_tools.pages.choose_locale')
+
+      .col-md-7
+        .input-group
+          %span.input-group-addon
+            %i.fa.fa-search
+
+          = form.input_field :identifier_or_path_or_title_or_description_or_keywords_or_canonical_cont, as: :string, placeholder: t('para.shared.search'), class: 'form-control'
+
+      .col-md-2
+        = form.submit t('para.shared.search'), class: 'btn btn-default btn-block'
+
+  - else
+    .input-group
+      %span.input-group-addon
+        %i.fa.fa-search
+
+      = form.input_field :identifier_or_path_or_title_or_description_or_keywords_or_canonical_cont, as: :string, placeholder: t('para.shared.search'), class: 'form-control'
+
+      %span.input-group-btn
+        = form.submit t('para.shared.search'), class: 'btn btn-default'

data/app/views/admin/para/seo_tools/pages/_form.html.haml

@@ -0,0 +1,13 @@
+= para_form_for(resource) do |form|
+  = form.fieldset do
+    = form.input :path, disabled: true
+
+    = meta_tag_input form, :title
+    = meta_tag_input form, :description
+    = meta_tag_input form, :keywords
+
+  = form.fieldset title: t('para.seo_tools.pages.additional_meta_tags') do
+    = meta_tag_input form, :image, as: :image
+    = meta_tag_input form, :canonical
+
+  = form.actions

data/app/views/admin/para/seo_tools/pages/_table.html.haml

@@ -0,0 +1,20 @@
+= resources_table(model: model, component: component, actions: false) do |table|
+  = table.header do
+    = table.header_for(:path)
+    = table.header_for(:title)
+    = table.header_for(:description)
+    = table.header_for(:locale) if @available_locales.length > 1
+    %th
+
+  = table.rows(resources) do |resource|
+    = table.data_for(resource, :path)
+    = table.data_for(resource.meta_tag(:title))
+    = table.data_for(resource.meta_tag(:description))
+    = table.data_for(resource, :locale) if @available_locales.length > 1
+
+    %td
+      .pull-right.btn-group
+        = table.edit_button(resource)
+
+        = link_to resource.path, target: '_blank', class: 'btn btn-default hint--left', data: { hint: t('para.seo_tools.pages.see_in_app') } do
+          = fa_icon 'eye'

data/app/views/admin/para/seo_tools/skeleton_resources/index.html.haml

@@ -0,0 +1,4 @@
+.page-title
+  %h1= @component.name
+
+= listing_for(@resources, addable: false)

data/bin/rails

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 4 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/para/seo_tools/engine', __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/para-seo_tools.fr.yml

@@ -0,0 +1,22 @@
+fr:
+  para:
+    seo_tools:
+      pages:
+        see_in_app: "Voir la page"
+        default_meta_tag_value: "Valeur par défaut : <b>%{value}</b>"
+        additional_meta_tags: "Meta-données avancées"
+        refresh_skeleton: "Mettre à jour"
+        choose_locale: "Choisissez une langue"
+
+  activerecord:
+    attributes:
+      para/seo_tools/page:
+        path: "URL de la page"
+        identifier: "Identifiant de la page"
+        title: "Titre"
+        description: "Description"
+        keywords: "Mots-clés de la page"
+        image: "Image pour le partage sur les réseaux sociaux"
+        canonical: "URL canonique"
+        locale: "Langue"
+

data/db/migrate/20150601085253_create_seo_tools_pages.rb

@@ -0,0 +1,14 @@
+class CreateSeoToolsPages < ActiveRecord::Migration
+  def change
+    create_table :seo_tools_pages do |t|
+      t.string :identifier
+      t.string :path
+      t.references :meta_tags_list, index: true, foreign_key: true
+
+      t.timestamps null: false
+    end
+
+    add_index :seo_tools_pages, :identifier
+    add_index :seo_tools_pages, :path
+  end
+end

data/db/migrate/20160610094032_add_meta_tags_to_seo_tools_pages.rb

@@ -0,0 +1,12 @@
+class AddMetaTagsToSeoToolsPages < ActiveRecord::Migration
+  def change
+    change_table :seo_tools_pages do |t|
+      t.string :title
+      t.text :description
+      t.text :keywords
+      t.attachment :image
+      t.text :canonical
+      t.jsonb :defaults
+    end
+  end
+end

data/db/migrate/20160614081242_add_locale_and_remove_meta_tags_list_to_seo_tools_pages.rb

@@ -0,0 +1,8 @@
+class AddLocaleAndRemoveMetaTagsListToSeoToolsPages < ActiveRecord::Migration
+  def change
+    change_table :seo_tools_pages do |t|
+      t.remove_references :meta_tags_list, index: true
+      t.string :locale
+    end
+  end
+end

data/lib/generators/para/seo_tools/install/install_generator.rb

@@ -0,0 +1,24 @@
+module Para
+  module SeoTools
+    class InstallGenerator < Rails::Generators::Base
+      # Copied files come from templates folder
+      source_root File.expand_path('../templates', __FILE__)
+
+      # Generator desc
+      desc 'Seo Tools install generator'
+
+      def copy_initializer_file
+        copy_file 'initializer.rb', 'config/initializers/seo_tools.rb'
+      end
+
+      def copy_and_run_migrations
+        rake 'para_seo_tools_engine:install:migrations'
+        rake 'db:migrate'
+      end
+
+      def create_skeleton_file
+        copy_file 'skeleton.rb', 'config/skeleton.rb'
+      end
+    end
+  end
+end

data/lib/generators/para/seo_tools/install/templates/initializer.rb

@@ -0,0 +1,33 @@
+Para::SeoTools.configure do |config|
+  # Configure the hostname for the sitemap
+  #
+  # Defaults to the ENV['APP_DOMAIN'] variable
+  #
+  # config.host = ENV['APP_DOMAIN']
+
+  # Default title methods to be checked for title
+  #
+  # config.title_methods = %w(title name)
+
+  # Default methods to be checked for description
+  #
+  # config.description_methods = %w(description desc content)
+
+  # Default image methods to be checked for image
+  #
+  # config.image_methods = %w(image picture avatar)
+
+  # Configure the default meta tags that will be used when no source could
+  # fill the defined meta.
+  #
+  # One good thing is to configure the title here to avoid empty <title> tags.
+  # But you can configure any supported meta tag here.
+  #
+  # Note that you'll need to pass a proc or lambda, and that it'll be executed
+  # in the context of the controller.
+  # This allows for example to set I18n aware defaults.
+  #
+  # config.defaults = lambda do
+  #   { title: 'My website' }
+  # end
+end

data/lib/generators/para/seo_tools/install/templates/skeleton.rb

@@ -0,0 +1,37 @@
+# Use `lazy: true` to avoid generating the pages skeleton on server run
+#
+# You'll then have to run `rake seo_tools:skeleton:build` to refresh it or use
+# the `Para::SeoTools::Skeleton::Worker.perform` method in some worker to
+# refresh it periodically
+#
+# Note that you also have to always refresh the sitemap manually with the
+# following task : `rake seo_tools:sitemap:generate`
+#
+Para::SeoTools::Skeleton.draw(lazy: false) do
+  # Define your website SEO targetted structure here.
+  # Pages are defined with the `page` method, and allows for some options.
+  #
+  # The following will define the page `posts` and call `posts_path` to retrieve
+  # its URL
+  #
+  #   page :posts
+  #
+  # If you want to define the page path yourself, just add the `:path` option
+  # to the `page` call
+  #
+  #   page :home, path: root_path
+  #
+  # When the page is linked to a resource : often, a #show page, you'll need to
+  # pass the `:resource` option
+  #
+  #   Posts.find_each do |post|
+  #     page :post, resource: post
+  #   end
+  #
+  # Also, you can pass options for the sitemap generation tool.
+  # The options are `:priority`, `:change_frequency` which are left blank
+  # by default.
+  #
+  #   page :posts, priority: 1, change_frequency: 'weekly'
+  #
+end

data/lib/para/seo_tools/controller.rb

@@ -0,0 +1,50 @@
+module Para
+  module SeoTools
+    module Controller
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :store_request_for_meta_tags_processing
+        helper_method :meta_tags_store
+        before_action :fetch_meta_tags_page
+      end
+
+      def meta_tags_store
+        @meta_tags_store ||= MetaTags::Store.new(self)
+      end
+
+      protected
+
+      def meta_tags_from(resource)
+        @instance = resource
+      end
+
+      def set_meta_tags_from_page(page)
+        if page.kind_of?(Para::SeoTools::Page)
+          Para::SeoTools::Page::META_TAGS.each do |tag_name|
+            if (value = page.meta_tag(tag_name)).present?
+              set_meta_tag(tag_name, value)
+            end
+          end
+        else
+          page = Para::SeoTools::Page.where(identifier: page.to_s).first
+          set_meta_tags_from_page(page) if page
+        end
+      end
+
+      def set_meta_tag(tag_name, value)
+        meta_tags_store.send(:"#{ tag_name }=", value)
+      end
+
+      def fetch_meta_tags_page
+        if (page = Para::SeoTools::Page.find_by_path(request.path))
+          set_meta_tags_from_page(page)
+        end
+      end
+
+      def store_request_for_meta_tags_processing
+        RequestStore.store[:'para.seo_tools.request'] = request
+      end
+    end
+  end
+end

data/lib/para/seo_tools/engine.rb

@@ -0,0 +1,27 @@
+module Para
+  module SeoTools
+    class Engine < Rails::Engine
+      config.after_initialize do
+        Para::SeoTools::Skeleton.load
+      end
+
+      initializer 'para.seo_tools.include_controller_mixin' do
+        ActiveSupport.on_load(:action_controller) do
+          include Para::SeoTools::Controller
+        end
+      end
+
+      initializer "para.seo_tools.include_view_helpers" do
+        ActiveSupport.on_load(:action_view) do
+          include Para::SeoTools::ViewHelpers
+        end
+      end
+
+      rake_tasks do
+        Dir[File.expand_path('../../tasks/**/*.rake', __FILE__)].each do |path|
+          load(path)
+        end
+      end
+    end
+  end
+end