para-seo_tools 0.4.0 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4b8959221c49d287170b758d7dbe9a0e2bb291b
-  data.tar.gz: 2c9f4d8e455c31bf0f47c7c1cdb1dffdd54a571f
+  metadata.gz: 724bd64d9cc63d30dd64a7c34f5ac844e2a4aa58
+  data.tar.gz: 2cddf86252810fc4f146f2e458e126d9a33b45f1
 SHA512:
-  metadata.gz: dd129c962571f25f126aeafed737ef17e86fb2e2ef73351bf1b416a4372c4a917f80b41017a614506001a2a2fe26ba829b7108e2675df715fe99015bea4ddc73
-  data.tar.gz: 0880f858c0a6db534a542182e456f46f126a2ce4271bef67fc19a7e62297fb1b1330b297b4278db6f435866bc564e280f631fcd71b61816ab1278e75989b1c07
+  metadata.gz: af089b88e4d1fd13ed69e23a853adca81ee3829c976dde442876adcf2de804ccaa1a41c7ab34c6adda4ec2225fe275d84e27ccffb4d5b48f7b9b266cfae8d667
+  data.tar.gz: 956ba99b6bcd1ca62cd691efbdad934e0f71ccba101467c701c653b24c3f296b190803fc0a02c8d5f6fb7e968081e60ab57b5693ef1decc9a0be9087d7b252f1

data/README.md

@@ -268,8 +268,8 @@ Then 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`.
+[Sitemap Generator](https://github.com/kjvarga/sitemap_generator) gem,
+with a custom task and interface 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.
@@ -277,7 +277,7 @@ 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"
+config.host = 'www.mydomain.com'
 ```
 
 Or with the `APP_DOMAIN` environment variable.
@@ -286,19 +286,30 @@ Or with the `APP_DOMAIN` environment variable.
 APP_DOMAIN="www.mydomain.com"
 ```
 
-Generating the sitemap can be done with the dedicated rake task :
+If you want to handle subdomains you need to set the `host` without a subdomain
+and the `default_subdomain` configs together :
 
-```bash
-rake seo_tools:sitemap:generate
+```ruby
+config.host = 'mydomain.com'
+config.default_subdomain = 'www'
 ```
 
-You can pass a `LOCATION` environment variable to define where to store it.
-By default, it will be stored at : `public/sitemap.xml`
+Generating the sitemap can be done with the dedicated rake task, or through
+the Seo Tools admin panel by refreshing it manually :
 
 ```bash
-rake seo_tools:sitemap:generate LOCATION=/home/user/apps/my-app/shared
+rake para:seo_tools:sitemap:generate
 ```
 
+This will generate the sitemap at `public/system/sitemap.xml.gz`. If you
+need to change that path, you can use the `sitemaps_path` configuration, which
+allows you to choose a `public/` subdirectory as the target folder for the
+generated sitemaps.
+
+For more customization informations, please read the
+[Sitemap Generator](https://github.com/kjvarga/sitemap_generator) gem
+documentation.
+
 ### 4. Retrieving meta tags in your app
 
 Meta tags edition and rendering is done through the

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

@@ -0,0 +1,17 @@
+module Para
+  module SeoTools
+    module Admin
+      class SkeletonRefreshesController < ::Para::Admin::JobsController
+        def run
+          job = Para::SeoTools::Skeleton::Job.perform_later
+          track_job(job)
+        end
+
+        def ping
+          job = Para::SeoTools::SitemapPinger.perform_later
+          track_job(job)
+        end
+      end
+    end
+  end
+end

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

@@ -6,15 +6,6 @@ module Para
           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

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

@@ -10,8 +10,10 @@ module Para
 
       validate :identifier_uniqueness
 
-      scope :with_subdomain, ->(subdomain) { where("config->>'subdomain' = ?", subdomain) }
-      scope :with_domain, ->(domain) { where("config->>'domain' = ?", domain) }
+      scope :with_subdomain, ->(subdomain) { scope_with(subdomain: subdomain) }
+      scope :with_domain, ->(domain) { scope_with(domain: domain) }
+
+      scope :scope_with, -> (attributes) { PageScoping.scope_with(self, attributes) }
 
       def meta_tag(name)
         if (value = send(name).presence) && (meta = process(name, value)).present?
@@ -61,9 +63,20 @@ module Para
         end
       end
 
-      def sitemap_host
+      def url
+        @url ||= [host, path].join
+      end
+
+      def host
         host = []
-        host << config['subdomain'] if Para::SeoTools.handle_subdomain
+
+        if Para::SeoTools.handle_subdomain
+          if (subdomain = config['subdomain'])
+            host << subdomain
+          else
+            host << Para::SeoTools.default_domain
+          end
+        end
 
         if Para::SeoTools.handle_domain
           host << config['domain']
@@ -71,7 +84,13 @@ module Para
           host << Para::SeoTools.host
         end
 
-        host.join('.')
+        host.compact.join('.')
+
+        [Para::SeoTools.protocol, host].join('://')
+      end
+
+      def siblings
+        self.class.where(identifier: identifier).where.not(id: id)
       end
 
       private

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

@@ -1,5 +1,10 @@
 %ul.panel-controls
   %li
-    = link_to @component.relation_path(action: :refresh, return_to: request.fullpath), class: 'btn btn-default' do
+    = link_to run_admin_skeleton_refresh_path, class: 'btn btn-default', 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
+      = fa_icon 'cloud-upload'
+      = t('para.seo_tools.pages.ping_search_engines')

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

@@ -6,8 +6,22 @@ fr:
         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"
 
+    jobs:
+      para/seo_tools/skeleton/job:
+        progressing: "Le plan du site est actuellement recalculé, merci de patienter quelques instants ..."
+        success: "Le plan du site a bien été mis à jour !"
+      para/seo_tools/sitemap_pinger:
+        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 !"
+
+  activemodel:
+    models:
+      para/seo_tools/skeleton/job: "Mise à jour du plan du site"
+      para/seo_tools/sitemap_pinger: "Envoi du sitemap"
+
   activerecord:
     attributes:
       para/seo_tools/page:

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

@@ -1,7 +1,7 @@
 # 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
+# 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

data/lib/para/seo_tools/controller.rb

@@ -21,6 +21,8 @@ module Para
 
       def set_meta_tags_from_page(page)
         if page.kind_of?(Para::SeoTools::Page)
+          meta_tags_store.page = page
+
           Para::SeoTools::Page::META_TAGS.each do |tag_name|
             if (value = page.meta_tag(tag_name)).present?
               set_meta_tag(tag_name, value)

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

@@ -20,8 +20,9 @@ module Para
             description_tag,
             keywords_tag,
             canonical_tag,
-            vendor_tags
-          ].compact.join(LINE_SEPARATOR).html_safe
+            vendor_tags,
+            hreflang_tags
+          ].flatten.compact.join(LINE_SEPARATOR).html_safe
         end
 
         private
@@ -68,7 +69,16 @@ module Para
             end
           end
 
-          vendor_tags.join(LINE_SEPARATOR)
+          vendor_tags
+        end
+
+        def hreflang_tags
+          return unless Para::SeoTools.generate_hreflang_tags
+          return unless meta_tags.page
+
+          SeoTools::PageScoping.new(meta_tags.page).alternate_language_siblings.map do |page|
+            tag(:link, rel: 'alternate', href: page.url, hreflang: page.locale)
+          end
         end
 
         def meta_tags

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

@@ -3,6 +3,7 @@ module Para
     module MetaTags
       class Store
         attr_reader :controller, :defaults
+        attr_accessor :page
 
         TAGS = :title, :description, :image, :url, :site_name, :keywords, :type,
                :site, :card, :charset, :canonical

data/lib/para/seo_tools/page_scoping.rb

@@ -14,15 +14,26 @@ module Para
         resource.scope.present?
       end
 
-      def column?(attribute)
-        resource.class.column_names.include?(attribute.to_s)
-      end
-
       def uniqueness_scope_conditions
         return resource.class unless scoped?
 
-        resource.scope_attributes.reduce(resource.class) do |query, (attribute, value)|
-          if column?(attribute)
+        self.class.scope_with(resource.class, resource.scope_attributes)
+      end
+
+      def unique_identifier
+        return resource.identifier unless scoped?
+
+        resource.scope_attributes.merge(identifier: resource.identifier).to_json
+      end
+
+      def alternate_language_siblings
+        attributes = resource.scope_attributes.reject { |attribute, _| attribute == 'locale' }
+        self.class.scope_with(resource.siblings, attributes)
+      end
+
+      def self.scope_with(resource_class, attributes)
+        attributes.reduce(resource_class) do |query, (attribute, value)|
+          if column?(resource_class, attribute)
             query.where(attribute => value)
           else
             query.where("config->>'#{ attribute }' = ?", value)
@@ -30,9 +41,8 @@ module Para
         end
       end
 
-      def unique_identifier
-        return resource.identifier unless scoped?
-        resource.scope_attributes.merge(identifier: resource.identifier).to_json
+      def self.column?(resource_class, attribute)
+        resource_class.column_names.include?(attribute.to_s)
       end
     end
   end

data/lib/para/seo_tools/routes.rb

@@ -3,9 +3,12 @@ module Para
     class Routes < Para::Plugins::Routes
       def draw
         plugin :seo_tools do
-          crud_component :seo_tools_skeleton, scope: ':model', controller: :skeleton_resources do
-            collection do
-              get :refresh
+          crud_component :seo_tools_skeleton, scope: ':model', controller: :skeleton_resources
+
+          namespace :admin do
+            resource :skeleton_refresh, only: [:show] do
+              get 'run'
+              get 'ping'
             end
           end
         end

data/lib/para/seo_tools/sitemap.rb

@@ -1,36 +1,26 @@
 module Para
   module SeoTools
     class Sitemap
-      def self.generate!
-        puts " * GENERATE SITEMAP ..."
-
-        build
-
-        puts " * BUILD ..."
-
-        ::Sitemap::Generator.instance.build!
-
-        puts " * SAVE ..."
-
-        ::Sitemap::Generator.instance.save(path)
-
-        puts " * SAVED !"
+      def self.prepare
+        SitemapGenerator::Sitemap.sitemaps_path = Para::SeoTools.sitemaps_path
+        SitemapGenerator::Sitemap.default_host = Para::SeoTools.full_host
       end
 
-      def self.path
-        @path ||= begin
-          root = ::Sitemap.configuration.save_path || ENV["LOCATION"] || Rails.public_path
-          File.join(root, "sitemap.xml")
-        end
-      end
+      def self.generate!
+        prepare
 
-      def self.build
-        ::Sitemap::Generator.instance.load do
+        SitemapGenerator::Sitemap.create do
           Para::SeoTools::Page.find_each do |page|
-            literal page.path, host: page.sitemap_host
+            add page.path, host: page.host
           end
         end
       end
+
+      def self.ping_search_engines
+        prepare
+
+        SitemapGenerator::Sitemap.ping_search_engines
+      end
     end
   end
 end

data/lib/para/seo_tools/sitemap_pinger.rb

@@ -0,0 +1,15 @@
+module Para
+  module SeoTools
+    class SitemapPinger < Para::Job::Base
+      def perform
+        Para::SeoTools::Sitemap.ping_search_engines
+      end
+
+      private
+
+      def progress_total
+        nil
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+module Para
+  module SeoTools
+    module Skeleton
+      class Job < Para::Job::Base
+        def perform
+          Para::SeoTools::Skeleton.build(load_skeleton: true)
+          Para::SeoTools::Sitemap.generate!
+        end
+
+        private
+
+        def progress_total
+          nil
+        end
+      end
+    end
+  end
+end

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

@@ -9,7 +9,7 @@ module Para
         attr_reader :name, :resource, :locale, :defaults, :config
 
         def initialize(name, path: nil, resource: nil, **options)
-          @name = name
+          @name = Array.wrap(name).join(':')
           @path = path
           @resource = resource
 

data/lib/para/seo_tools/skeleton.rb

@@ -5,7 +5,7 @@ module Para
 
       autoload :Site
       autoload :PageBuilder
-      autoload :Worker
+      autoload :Job
 
       mattr_accessor :site, :config, :options, :enable_logging
 

data/lib/para/seo_tools/version.rb

@@ -1,5 +1,5 @@
 module Para
   module SeoTools
-    VERSION = "0.4.0"
+    VERSION = "0.4.2"
   end
 end

data/lib/para/seo_tools.rb

@@ -1,4 +1,4 @@
-require 'sitemap'
+require 'sitemap_generator'
 require 'para'
 
 require 'para/seo_tools/engine'
@@ -12,6 +12,7 @@ module Para
     autoload :Routes
     autoload :Skeleton
     autoload :Sitemap
+    autoload :SitemapPinger
     autoload :PageScoping
 
     autoload :MetaTaggable
@@ -19,7 +20,10 @@ module Para
     autoload :ViewHelpers
 
     mattr_writer :host
-    @@host = ENV['APP_DOMAIN']
+    @@host = nil
+
+    mattr_accessor :protocol
+    @@protocol = :http
 
     mattr_accessor :handle_domain
     @@handle_domain = false
@@ -27,6 +31,9 @@ module Para
     mattr_accessor :handle_subdomain
     @@handle_subdomain = false
 
+    mattr_accessor :default_subdomain
+    @@default_subdomain = nil
+
     mattr_accessor :title_methods
     @@title_methods = %w(title name)
 
@@ -39,6 +46,12 @@ module Para
     mattr_accessor :defaults
     @@defaults = nil
 
+    mattr_accessor :generate_hreflang_tags
+    @@generate_hreflang_tags = false
+
+    mattr_accessor :sitemaps_path
+    @@sitemaps_path = 'system/'
+
     def self.configure
       block_given? ? yield(self) : self
     end
@@ -48,7 +61,12 @@ module Para
     end
 
     def self.host
-      @@host.presence && @@host.match(/[^:]+/)[0]
+      @@host ||= ENV['APP_DOMAIN']
+    end
+
+    def self.full_host
+      host = [Para::SeoTools.default_subdomain, Para::SeoTools.host].compact.join(',')
+      [Para::SeoTools.protocol, host].join('://')
     end
   end
 end

data/lib/tasks/para_seo_tools_tasks.rake

@@ -15,7 +15,7 @@ namespace :para do
 
       desc "Ping engines."
       task ping: :environment do
-        ::Sitemap::Ping.send_request(Para::SeoTools::Sitemap.path)
+        SitemapGenerator::Sitemap.ping_search_engines
       end
     end
   end

data/para-seo_tools.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'rails', '>= 4.0', '< 5.0'
-  spec.add_dependency 'sitemap', '~> 0.3'
+  spec.add_dependency 'sitemap_generator'
   spec.add_dependency 'request_store'
 
   spec.add_development_dependency "bundler", "~> 1.7"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: para-seo_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.2
 platform: ruby
 authors:
 - Valentin Ballestrino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-03 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -31,19 +31,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: sitemap
+  name: sitemap_generator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -102,6 +102,7 @@ files:
 - app/.DS_Store
 - app/components/seo_tools_skeleton_component.rb
 - app/controllers/.DS_Store
+- app/controllers/para/seo_tools/admin/skeleton_refreshes_controller.rb
 - app/controllers/para/seo_tools/admin/skeleton_resources_controller.rb
 - app/decorators/seo_tools_skeleton_component_decorator.rb
 - app/helpers/para/seo_tools/admin/fields_helper.rb
@@ -142,10 +143,11 @@ files:
 - lib/para/seo_tools/page_scoping.rb
 - lib/para/seo_tools/routes.rb
 - lib/para/seo_tools/sitemap.rb
+- lib/para/seo_tools/sitemap_pinger.rb
 - lib/para/seo_tools/skeleton.rb
+- lib/para/seo_tools/skeleton/job.rb
 - lib/para/seo_tools/skeleton/page_builder.rb
 - lib/para/seo_tools/skeleton/site.rb
-- lib/para/seo_tools/skeleton/worker.rb
 - lib/para/seo_tools/version.rb
 - lib/para/seo_tools/view_helpers.rb
 - lib/tasks/migration.rake
@@ -173,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: SEO tools for the Para CMS

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

@@ -1,11 +0,0 @@
-module Para
-  module SeoTools
-    module Skeleton
-      class Worker
-        def self.perform
-          Para::SeoTools::Skeleton.build
-        end
-      end
-    end
-  end
-end