para-seo_tools 0.4.6 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 963b8c1e96cb711ed75e3331dc352557be853672
-  data.tar.gz: b22ecd8d54cf19e155e598eaafded1204292e664
+  metadata.gz: 7897b0a3299f5d4e457e8eba6b499c24e7a0b2c0
+  data.tar.gz: d5356532cdaeb00740c523d945665a5f945fcf56
 SHA512:
-  metadata.gz: ec6e122729a5b47932f5659c5a53e11b04360b97819efc6e93939216cab0b412b3bebd4c57aff4913cbfeb74a4c366c34198b9b8f7270fee69f51b5dbfac6bb4
-  data.tar.gz: 94f0d7408d3a93399a80e248d84d7947cb300f0cdc97f897a5a55f16b283e630f57b954e8d583ca16652ee5ac7ff3413ac1af8d94569d91a00195c6478c7820f
+  metadata.gz: 2f21f538ce3f45348d99cbc0936bda4f9699f8bf8bf137cffb368ccfb8b18aaedb3484e565a194ad03f09a2bfb0de4ea37dfce2b7527f8cf24cfe885006c2480
+  data.tar.gz: a79fb1e83edf1f3c587d109910ec1af1ffc8beabeb683ae3637139eb34da1c7c47f6133bc75d13668906e27f383b8b1375a22c41d04c1b20bc93e5cefc696f30

data/README.md

@@ -11,7 +11,7 @@ for filling out all the pages' meta tags.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'seo_tools-para'
+gem 'para-seo_tools'
 ```
 
 And then execute:
@@ -29,7 +29,7 @@ gem install seo_tools-para
 Run the installation generator :
 
 ```bash
-rails generate seo_tools:install
+rails generate para:seo_tools:install
 ```
 
 ## Usage
@@ -48,7 +48,7 @@ In the following section, you'll find how to :
 
 ### 1. Define the sitemap
 
-When you run the `seo_tools:install` generator, a file is created at
+When you run the `para: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
@@ -233,7 +233,7 @@ end
 Then use the following rake task :
 
 ```bash
-rake seo_tools:skeleton:build
+rake para:seo_tools:skeleton:build
 ```
 
 #### Domain and subdomains handling

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

@@ -1,10 +1,10 @@
-%ul.panel-controls
+%ul.actions-control
   %li
-    = link_to run_admin_skeleton_refresh_path, class: 'btn btn-default', remote: true, data: { :'job-tracker-button' => true } do
+    = link_to run_admin_skeleton_refresh_path, class: 'btn btn-default btn-shadow', remote: true, data: { :'job-tracker-button' => true } do
       = fa_icon 'refresh'
       = t('para.seo_tools.pages.refresh_skeleton')
 
   %li
-    = link_to ping_admin_skeleton_refresh_path, class: 'btn btn-default', remote: true, data: { :'job-tracker-button' => true } do
+    = link_to ping_admin_skeleton_refresh_path, class: 'btn btn-default btn-shadow', remote: true, data: { :'job-tracker-button' => true } do
       = fa_icon 'cloud-upload'
       = t('para.seo_tools.pages.ping_search_engines')

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

@@ -1,18 +1,16 @@
 = search_form_for @q, builder: SimpleForm::FormBuilder, url: @component.path, html: { data: { :'filters-form' => true } } do |form|
-  %table
-    %tbody
-      %tr
-        - if Para::SeoTools.handle_subdomain
-          %td{ width: '15%', style: 'padding-right: 10px;' }
-            = form.input_field :subdomain_eq, as: :selectize, collection: Para::SeoTools::Page.available_subdomains, class: 'form-control', placeholder: t('para.seo_tools.pages.subdomain')
-        - if @available_locales.length > 1
-          %td{ width: '15%', style: 'padding-right: 10px;' }
-            = form.input_field :locale_eq, as: :selectize, collection: @available_locales, class: 'form-control', placeholder: t('para.seo_tools.pages.choose_locale')
-        %td{ width: '80%' }
-          .col-sm-12
-            .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'
-        %td{ width: '20%' }
-          = form.submit t('para.shared.search'), class: 'btn btn-default btn-block'
+
+  - if Para::SeoTools.handle_subdomain
+    .flextable-item
+      = form.input_field :subdomain_eq, as: :selectize, collection: Para::SeoTools::Page.available_subdomains, class: 'form-control', placeholder: t('para.seo_tools.pages.subdomain')
+
+  - if @available_locales.length > 1
+    .flextable-item
+      = form.input_field :locale_eq, as: :selectize, collection: @available_locales, class: 'form-control', placeholder: t('para.seo_tools.pages.choose_locale')
+      
+  .flextable-item.flextable-primary
+    .input-group.filter-form
+      = 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'
+      .input-group-btn
+        %button.btn{ type: 'submit' }
+          = fa_icon 'search'

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

@@ -1,13 +1,14 @@
 = para_form_for(resource) do |form|
-  = form.fieldset do
-    = form.input :path, disabled: true
+  = form.tabs do |tabs|
+    = tabs.tab :informations, icon: 'info-circle' do
+      = form.input :path, disabled: true
 
-    = meta_tag_input form, :title
-    = meta_tag_input form, :description
-    = meta_tag_input form, :keywords
+      = 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
+    = tabs.tab :additional_meta_tags, icon: 'cog' do
+      = meta_tag_input form, :image, as: :image, hint: t('para.seo_tools.pages.image_hint')
+      = meta_tag_input form, :canonical, hint: t('para.seo_tools.pages.canonical_hint')
 
   = form.actions

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

@@ -5,7 +5,7 @@
     = table.header_for(:title)
     = table.header_for(:description)
     = table.header_for(:locale) if @available_locales.length > 1
-    %th
+    %th.table-row-actions
 
   = table.rows(resources) do |resource|
     = table.data_for(resource.subdomain) if Para::SeoTools.handle_subdomain
@@ -14,9 +14,8 @@
     = 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)
+    %td.table-row-actions
+      = 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'
+      = link_to resource.path, target: '_blank', class: 'btn btn-sm btn-icon-default btn-shadow hint--left', aria: { label: t('para.seo_tools.pages.see_in_app') } do
+        = fa_icon 'eye'

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

@@ -4,11 +4,16 @@ fr:
       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"
         ping_search_engines: "Envoyer le sitemap aux moteurs de recherche"
         choose_locale: "Choisissez une langue"
         subdomain: Sous-domaine
+        image_hint: |
+          Cette image sera utilisée par défaut comme prévisualisation de la page
+          lors de son partage sur les réseaux sociaux.
+        canonical_hint: |
+          Si la page ne doit pas être référencée au profit d'une autre page,
+          collez ici l'adresse de la page à référencer à la place.
 
     jobs:
       para/seo_tools/skeleton/job:
@@ -18,6 +23,16 @@ fr:
         progressing: "Le plan du site est actuellement envoyé aux différents moteurs de recherche ..."
         success: "Le plan du site a bien été transmis aux moteurs de recherche !"
 
+  components:
+    component:
+      sitemap: "Gestion SEO / Plan du site"
+
+  forms:
+    tabs:
+      para/seo_tools/page:
+        informations: "Informations"
+        additional_meta_tags: "Meta-données avancées"
+
   activemodel:
     models:
       para/seo_tools/skeleton/job: "Mise à jour du plan du site"
@@ -31,8 +46,8 @@ fr:
         title: "Titre"
         description: "Description"
         keywords: "Mots-clés de la page"
-        image: "Image pour le partage sur les réseaux sociaux"
-        canonical: "URL canonique"
+        image: "Image pour le partage"
+        canonical: "URL canonique (Canonical)"
         locale: "Langue"
         subdomain: "Sous-domaine"
 

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

@@ -1,11 +1,11 @@
 # 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::Job.perform` method in some worker to
+# You'll then have to run `rake para:seo_tools:skeleton:build` to refresh it or
+# use the `Para::SeoTools::Skeleton::Job.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`
+# following task : `rake para:seo_tools:sitemap:generate`
 #
 Para::SeoTools::Skeleton.draw(lazy: false) do
   # Define your website SEO targetted structure here.
@@ -16,11 +16,13 @@ Para::SeoTools::Skeleton.draw(lazy: false) do
   #
   #   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
   #
@@ -28,10 +30,36 @@ Para::SeoTools::Skeleton.draw(lazy: false) do
   #     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'
   #
+  #
+  # By default, when you pass a resource to a route, it will try to find
+  # default a title and description from your resource, using the method
+  # configured in the seo_tools.rb initializer at `config.title_methods` and
+  # `config.description_methods`.
+  #
+  # For non-resource pages or if you need to add your own defaults, you can
+  # pass them to the `#page` method the following way :
+  #
+  #   page :posts, defaults: { title: 'Blog index', description: 'Read our blog ...' }
+  #   page :post, resource: post, defaults: { description: post.excerpt }
+  #
+  #
+  # By default, every page that is not referenced in the skeleton will not be
+  # indexed by search engines.
+  #
+  # But if some of your skeleton pages shouldn't be
+  # indexed or links shouldn't be followed on that page, you can explicitly pass
+  # the `:noindex` and `:nofollow` options to the `#page` method.
+  #
+  # It allows to let the admins edit the page title but avoids it to be indexed.
+  #
+  #   page :posts, noindex: true
+  #   page :report_abuse, noindex: true, nofollow: true
+  #
 end

data/lib/para/seo_tools/controller.rb

@@ -16,7 +16,7 @@ module Para
       protected
 
       def meta_tags_from(resource)
-        @instance = resource
+        @resource = resource
       end
 
       def set_meta_tags_from_page(page)

data/lib/para/seo_tools/helpers.rb

@@ -5,6 +5,7 @@ module Para
 
       autoload :PageHelper
       autoload :ViewHelper
+      autoload :DefaultDataMethodsHelper
     end
   end
 end

data/lib/para/seo_tools/helpers/default_data_methods_helper.rb

@@ -0,0 +1,31 @@
+module Para
+  module SeoTools
+    module Helpers
+      module DefaultDataMethodsHelper
+        def default_title_for(resource)
+          default_data_from_method_for(:title, resource)
+        end
+
+        def default_description_for(resource)
+          default_data_from_method_for(:description, resource)
+        end
+
+        def default_image_for(resource)
+          default_data_from_method_for(:image, resource)
+        end
+
+        # Try all default methods on resource
+        def default_data_from_method_for(method, resource)
+          return unless resource
+
+          Para::SeoTools.send(:"#{ method }_methods").each do |method|
+            data = resource.try(method)
+            return data if data.present?
+          end
+          # Avoid returning the methods enumerable returned by the #each call
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/renderer.rb

@@ -21,7 +21,8 @@ module Para
             keywords_tag,
             canonical_tag,
             vendor_tags,
-            hreflang_tags
+            hreflang_tags,
+            index_tags
           ].flatten.compact.join(LINE_SEPARATOR).html_safe
         end
 
@@ -81,6 +82,19 @@ module Para
           end
         end
 
+        def index_tags
+          noindex = !meta_tags.page || meta_tags.page.config['noindex']
+          nofollow = meta_tags.page && meta_tags.page.config['nofollow']
+
+          if noindex || nofollow
+            content = []
+            content << 'noindex' if noindex
+            content << 'nofollow' if nofollow
+
+            tag(:meta, name: 'robots', content: content.join(','))
+          end
+        end
+
         def meta_tags
           @meta_tags ||= template.controller.meta_tags_store
         end

data/lib/para/seo_tools/meta_tags/tags/base.rb

@@ -34,9 +34,9 @@ module Para
             key.join(".")
           end
 
-          # TODO : Define if we'll still support instance meta tags and refactor
+          # TODO : Define if we'll still support resource meta tags and refactor
           #        accordingly
-          def instance
+          def resource
           end
 
           def model_name

data/lib/para/seo_tools/meta_tags/tags/description.rb

@@ -3,9 +3,11 @@ module Para
     module MetaTags
       module Tags
         class Description < Base
+          include Para::SeoTools::Helpers::DefaultDataMethodsHelper
+
           def value
             self.class.process(
-              meta_taggable_description || instance_description || action_name
+              meta_taggable_description || resource_description || action_name
             )
           end
 
@@ -16,22 +18,12 @@ module Para
           private
 
           def meta_taggable_description
-            instance && instance.meta_tagged? &&
-              instance.meta_tags_list.meta_description.presence
+            resource && resource.meta_tagged? &&
+              resource.meta_tags_list.meta_description.presence
           end
 
-          def instance_description
-            if instance
-              Para::SeoTools.description_methods.each do |method|
-                if instance.respond_to?(method)
-                  if (description = instance.send(method).presence)
-                    return description
-                  end
-                end
-              end
-
-              return nil
-            end
+          def resource_description
+            default_description_for(resource)
           end
 
           def action_name

data/lib/para/seo_tools/meta_tags/tags/image.rb

@@ -4,7 +4,7 @@ module Para
       module Tags
         class Image < Base
           def value
-            self.class.process(instance_image)
+            self.class.process(resource_image)
           end
 
           def self.process(value)
@@ -23,16 +23,8 @@ module Para
 
           private
 
-          def instance_image
-            if member_action?
-              Para::SeoTools.image_methods.each do |method|
-                if instance.respond_to?(method) && instance.send(method)
-                  return instance.send(method).url
-                end
-              end
-
-              nil
-            end
+          def resource_image
+            default_image_for(resource).try(:url)
           end
 
           def self.url_from(value)

data/lib/para/seo_tools/meta_tags/tags/keywords.rb

@@ -10,8 +10,8 @@ module Para
           private
 
           def meta_taggable_keywords
-            instance && instance.meta_tagged? &&
-              instance.meta_tags_list.meta_keywords.presence
+            resource && resource.meta_tagged? &&
+              resource.meta_tags_list.meta_keywords.presence
           end
         end
       end

data/lib/para/seo_tools/meta_tags/tags/title.rb

@@ -3,26 +3,21 @@ module Para
     module MetaTags
       module Tags
         class Title < Base
+          include Para::SeoTools::Helpers::DefaultDataMethodsHelper
+
           def value
-            meta_taggable_title || instance_title || action_name || model_name_translation
+            meta_taggable_title || resource_title || action_name || model_name_translation
           end
 
           private
 
           def meta_taggable_title
-            instance && instance.meta_tagged? &&
-              instance.meta_tags_list.meta_title.presence
+            resource && resource.meta_tagged? &&
+              resource.meta_tags_list.meta_title.presence
           end
 
-          def instance_title
-            if instance
-              Para::SeoTools.title_methods.each do |method|
-                if instance.respond_to?(method) && (title = instance.send(method)).presence
-                  return title
-                end
-              end
-              return nil
-            end
+          def resource_title
+            default_title_for(resource)
           end
 
           def action_name

data/lib/para/seo_tools/sitemap.rb

@@ -10,8 +10,11 @@ module Para
         prepare
 
         SitemapGenerator::Sitemap.create do
-          Para::SeoTools::Page.where('path ~* ?', Para::SeoTools.sitemap_path_regexp).find_each do |page|
-            add page.path, host: page.host
+          Para::SeoTools::Page.where(
+            "path ~* ? AND CAST(config->>'noindex' AS boolean) != ?",
+            Para::SeoTools.sitemap_path_regexp, true
+          ).find_each do |page|
+            add(page.path, host: page.host) unless page.config['noindex']
           end
         end
       end

data/lib/para/seo_tools/skeleton/page_builder.rb

@@ -5,6 +5,7 @@ module Para
 
       class PageBuilder
         include Rails.application.routes.url_helpers
+        include Para::SeoTools::Helpers::DefaultDataMethodsHelper
 
         attr_reader :name, :resource, :locale, :defaults, :config
 
@@ -58,8 +59,9 @@ module Para
             # Override path (i.e.: slug changed)
             page.path = path if path.to_s != page.path
             page.locale = locale
+
             # Do not override meta tags if already present
-            page.defaults = defaults
+            page.defaults = process_defaults
             page.config = config
           end
         end
@@ -74,6 +76,15 @@ module Para
           end
         end
 
+        def process_defaults
+          return {} if defaults == false
+
+          defaults[:title] ||= default_title_for(resource)
+          defaults[:description] ||= default_description_for(resource)
+
+          defaults
+        end
+
         def self.model_for(page)
           models[unique_identifier_for(page)] ||= ::Para::SeoTools::Page.new(
             identifier: page.identifier

data/lib/para/seo_tools/skeleton/site.rb

@@ -10,7 +10,7 @@ module Para
           @default_page_options = options
         end
 
-        def page(name, options = {} , &block)
+        def page(name, options = {}, &block)
           options.reverse_merge!(default_page_options)
 
           Skeleton::PageBuilder.new(name, options).tap do |page|

data/lib/para/seo_tools/version.rb

@@ -1,5 +1,5 @@
 module Para
   module SeoTools
-    VERSION = "0.4.6"
+    VERSION = "0.5.0"
   end
 end

data/lib/tasks/para_seo_tools_tasks.rake

@@ -3,6 +3,7 @@ namespace :para do
     namespace :skeleton do
       desc "Builds or refreshes the app skeleton."
       task build: :environment do
+        puts "  * Build app skeleton ..."
         Para::SeoTools::Skeleton.build(load_skeleton: true)
       end
     end
@@ -10,6 +11,9 @@ namespace :para do
     namespace :sitemap do
       desc "Generates a new sitemap."
       task generate: :environment do
+        Rake.application.invoke_task('para:seo_tools:skeleton:build')
+
+        puts "  * Generate sitemap ..."
         Para::SeoTools::Sitemap.generate!
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: para-seo_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.5.0
 platform: ruby
 authors:
 - Valentin Ballestrino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-07 00:00:00.000000000 Z
+date: 2017-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -125,6 +125,7 @@ files:
 - lib/para/seo_tools/controller.rb
 - lib/para/seo_tools/engine.rb
 - lib/para/seo_tools/helpers.rb
+- lib/para/seo_tools/helpers/default_data_methods_helper.rb
 - lib/para/seo_tools/helpers/page_helper.rb
 - lib/para/seo_tools/helpers/view_helper.rb
 - lib/para/seo_tools/meta_tags.rb