camaleon_sitemap_customizer 0.5.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 044b819320b8c634f74f959e3efc63992fd462b0e3d9ae9843f6f5c98e3b34cb
-  data.tar.gz: 92ec9e59355e9dd61e7b24e610a328937d1d418c88bc6d111ab021f4f4ba6edc
+  metadata.gz: 1e3b2de62c6a36766e25f4a1e66779e40dbed80fda1956abf2b39196b2b4c30b
+  data.tar.gz: 274372e1b11f769b706b2d9a2e5c37687dd7563587246c5b6bf28fcdb395647b
 SHA512:
-  metadata.gz: 9f68a337bcb208a34d1b9871c3eecd679c79528344810dccc352cf70d18f757294f52fc97846b0976b1e7ee57cf274770a50ab2faa573fb5bd128d59c133fcbf
-  data.tar.gz: db02eccb4dc720e528009c6baae6c49b036dbbb5014bb09bad2bca44aafb23d298aa041c9eeb43d91bf6975baac5a89069bc2e65b274c266e8dade18e8e536d3
+  metadata.gz: e8ab214a2b7c6bde032d58fbb43dade4f1fcaccb45f0c014029e27caca070a2ed4e9e51a65869576d655abd78d3e9dfadb2b32c5d8db5cee1712d84cc7e92c11
+  data.tar.gz: 1dcce635a28669151d5055b3ba02ad98155e597ca2bb40e0198f9a8e9aace780515db293a3a95ad6cd447ba4e84f6b3851b5174acedee3a12bff469c296eb93d

data/README.md

@@ -1,11 +1,15 @@
+![](https://img.shields.io/badge/ruby-2.3%2B-red.svg)
+![Gem Version](https://img.shields.io/gem/v/camaleon_sitemap_customizer.svg?colorB=blue)
 [![Build Status](https://travis-ci.com/brian-kephart/camaleon_sitemap_customizer.svg?branch=master)](https://travis-ci.com/brian-kephart/camaleon_sitemap_customizer)
 
-# Sitemap Customizer
+# Camaleon Sitemap Customizer
 Camaleon CMS automatically generates sitemaps for all content of your site. This plugin allows you to select content to omit from the sitemap. You may wish to do this for a variety of reasons:
 - Keep search engines from indexing pages that are not relevant to the general public.
 - Keep search engines from indexing summary pages that only contain duplicate content.
 - Remove redundant entries. (ex. – 'https://yoursite.com', 'https://yoursite.com/index')
 
+This plugin also comes with an optional sitemap template that includes caching to speed up rendering.
+
 ## Installation
 Add this line to your application's Gemfile:
 
@@ -30,9 +34,19 @@ Use the site settings (/admin/plugins/camaleon_sitemap_customizer/settings) to:
 - Select **categories** for which to exclude list pages, same as above.
 - Exclude all **tag** list pages.
 - Exclude post url for page designated as the homepage. For example, if you have a page called '/index' that you have set as your homepage in the site settings, the sitemap will list the same page at 'http://yoursite.com/' and 'http://yoursite.com/index'. This option allows you to avoid the duplicate listing.
+- Choose whether to use the included sitemap template, which includes caching to speed up rendering.
 
 This plugin also adds an option to each post for exclusion from the sitemap. This is accessible via the regular post editor, rather than in the plugin settings.
 
+### About sitemap caching
+The default sitemaps in Camaleon render very slowly due to the many database queries required for them to be accurate. This may not be noticeable on small sites, but large ones can sometimes take several seconds to render. This can be sped up with caching, but Camaleon's Front Cache plugin does not render XML.
+
+This plugin offers an XML builder template that uses Russian doll caching to speed up rendering. It can be enabled on the settings page.
+
+If you wish to make changes to the included template:
+1. **Disable** the caching option in the plugin settings.
+2. Copy the included `app/views/themes/default/views/sitemap_with_caching.xml.builder` into your app's `app/apps/themes/your_theme/views/sitemap.xml.builder` and make your changes. Camaleon will use the `sitemap.xml.builder` file in your theme directory by default.
+
 ## Contributing
 See CONTRIBUTING.md
 

data/app/controllers/plugins/camaleon_sitemap_customizer/admin_controller.rb

@@ -5,7 +5,8 @@ class Plugins::CamaleonSitemapCustomizer::AdminController < CamaleonCms::Apps::P
     'skip_category_list_types' => [],
     'skip_all_categories' => false,
     'skip_tags' => false,
-    'skip_home' => false
+    'skip_home' => false,
+    'cache' => Rails.env.test? ? true : false
   }.freeze
 
   include Plugins::CamaleonSitemapCustomizer::MainHelper

data/app/helpers/plugins/camaleon_sitemap_customizer/main_helper.rb

@@ -31,8 +31,15 @@ module Plugins::CamaleonSitemapCustomizer::MainHelper
     args[:skip_posttype_ids] += current_plugin.get_option('skip_post_list_types')&.map(&:to_i).presence || []
     args[:skip_cat_ids]      += select_categories
     args[:skip_tag_ids]      += current_site.the_tags.map(&:id) if current_plugin.get_option('skip_tags')
+
+    # exclude individual posts via post editor option
     args[:skip_post_ids]     += current_plugin.get_option('skip_posts').presence || []
+
+    # exclude redundant home page url
     args[:skip_post_ids]     << current_site.options.dig(:home_page).to_i if current_plugin.get_option('skip_home') && current_site.options.dig(:home_page).present?
+
+    # use caching in sitemap
+    args[:render] = cached_sitemap_template if current_plugin.get_option('cache').present?
   end
 
   def camaleon_sitemap_customizer_form(args)
@@ -51,6 +58,8 @@ module Plugins::CamaleonSitemapCustomizer::MainHelper
     skip_posts current_plugin
   end
 
+  private
+
   def skip_posts(plugin)
     plugin.set_option 'skip_posts', current_site.the_posts.eager_load(:metas).select { |post| post.get_option('hide_in_sitemap').present? } .map(&:id)
   end
@@ -62,4 +71,8 @@ module Plugins::CamaleonSitemapCustomizer::MainHelper
       current_plugin.get_option('skip_category_list_types')&.map(&:to_i).presence || []
     end
   end
+
+  def cached_sitemap_template
+    'sitemap_with_caching'
+  end
 end

data/app/views/camaleon_cms/default_theme/sitemap_with_caching.xml.builder

@@ -0,0 +1,81 @@
+xml.instruct! :xml, version: '1.0'
+xml.urlset xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9' do
+  current_site.get_languages.each_with_index do |lang, index|
+    lang = (index.zero? ? nil : lang)
+    xml.url do
+      xml.loc current_site.the_url(locale: lang)
+      xml.lastmod current_site.updated_at.to_date
+      xml.changefreq 'daily'
+      xml.priority '1.0'
+    end
+
+    cache ["xml_sitemap/posts/#{current_site.the_posts.maximum :updated_at}", @r[:skip_post_ids]] do
+      current_site.the_posts.decorate.each do |post|
+        next if @r[:skip_post_ids].include? post.id
+        cache post do
+          xml.url do
+            xml.loc post.the_url(locale: lang)
+            xml.lastmod post.updated_at.to_date
+            xml.changefreq 'monthly'
+            xml.priority '0.5'
+          end
+        end
+      end
+    end
+
+    cache ["xml_sitemap/categories/#{current_site.full_categories.maximum :updated_at}", @r[:skip_cat_ids]] do
+      current_site.full_categories.no_empty.decorate.each do |cat|
+        next if @r[:skip_cat_ids].include? cat.id
+        cache cat do
+          xml.url do
+            xml.loc cat.the_url(locale: lang)
+            xml.lastmod cat.updated_at.to_date
+            xml.changefreq 'monthly'
+            xml.priority '0.5'
+          end
+        end
+      end
+    end
+
+    cache ["xml_sitemap/post_types/#{current_site.post_types.maximum :updated_at}", @r[:skip_posttype_ids]] do
+      current_site.post_types.decorate.each do |ptype|
+        next if @r[:skip_posttype_ids].include? ptype.id
+        cache ptype do
+          xml.url do
+            xml.loc ptype.the_url(locale: lang)
+            xml.lastmod ptype.updated_at.to_date
+            xml.changefreq 'monthly'
+            xml.priority '0.5'
+          end
+        end
+      end
+    end
+
+    cache ["xml_sitemap/post_tags/#{current_site.post_types.maximum :updated_at}", @r[:skip_tag_ids]] do
+      current_site.post_tags.decorate.each do |tag|
+        next if @r[:skip_tag_ids].include? tag.id
+        cache tag do
+          xml.url do
+            xml.loc tag.the_url(locale: lang)
+            xml.lastmod tag.updated_at.to_date
+            xml.changefreq 'monthly'
+            xml.priority '0.5'
+          end
+        end
+      end
+    end
+  end
+
+  cache @r[:custom] do
+    @r[:custom].each do |_key, item|
+      cache item do
+        xml.url do
+          xml.loc item[:url]
+          xml.lastmod item[:lastmod] || Date.today.to_s
+          xml.changefreq item[:changefreq] || 'monthly'
+          xml.priority item[:priority] || '0.5'
+        end
+      end
+    end
+  end
+end

data/app/views/plugins/camaleon_sitemap_customizer/admin/settings.html.erb

@@ -56,6 +56,10 @@
         <%= check_box_tag "options[skip_home]", 1, @plugin.get_option('skip_home'), style: 'display: block;' %>
       </div>
 
+      <div class="form-group">
+        <label><%= cama_t 'cache' %></label>
+        <%= check_box_tag "options[cache]", 1, @plugin.get_option('cache'), style: 'display: block;' %>
+      </div>
 
       <div class="form-group text-right">
         <%= link_to 'View Sitemap', '/sitemap', target: 'blank' %>&nbsp;&nbsp;&nbsp;&nbsp;

data/config/locales/en.yml

@@ -8,3 +8,4 @@ en:
   categories_all: "Exclude ALL Categories (overrides above setting)"
   tags: "Exclude Tags"
   homepage: "Exclude duplicate home page url? (ex. – remove www.mysite.com/home if this renders the same post as www.mysite.com)"
+  cache: "Use caching to speed up sitemap rendering?"

data/lib/camaleon_sitemap_customizer/version.rb

@@ -1,3 +1,3 @@
 module CamaleonSitemapCustomizer
-  VERSION = '0.5.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camaleon_sitemap_customizer
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Brian Kephart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-27 00:00:00.000000000 Z
+date: 2018-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: camaleon_cms
@@ -65,6 +65,7 @@ files:
 - Rakefile
 - app/controllers/plugins/camaleon_sitemap_customizer/admin_controller.rb
 - app/helpers/plugins/camaleon_sitemap_customizer/main_helper.rb
+- app/views/camaleon_cms/default_theme/sitemap_with_caching.xml.builder
 - app/views/plugins/camaleon_sitemap_customizer/admin/settings.html.erb
 - config/camaleon_plugin.json
 - config/locales/en.yml