camaleon_sitemap_customizer 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e3b2de62c6a36766e25f4a1e66779e40dbed80fda1956abf2b39196b2b4c30b
-  data.tar.gz: 274372e1b11f769b706b2d9a2e5c37687dd7563587246c5b6bf28fcdb395647b
+  metadata.gz: 6ad9758dc86d24fe6230d89e0b42d1e5e80d1317e1f8be9f6bca54ae3d0bb2be
+  data.tar.gz: 8f9d394eab31aba632a49e2a96f17dbea90acc56a941e30f17d36b96d4abeafe
 SHA512:
-  metadata.gz: e8ab214a2b7c6bde032d58fbb43dade4f1fcaccb45f0c014029e27caca070a2ed4e9e51a65869576d655abd78d3e9dfadb2b32c5d8db5cee1712d84cc7e92c11
-  data.tar.gz: 1dcce635a28669151d5055b3ba02ad98155e597ca2bb40e0198f9a8e9aace780515db293a3a95ad6cd447ba4e84f6b3851b5174acedee3a12bff469c296eb93d
+  metadata.gz: 215630221044ccefc5579e0260fdabd49d856f324b739cd88b4e3f6edb22ef98b3caaceed6946cdbb44fa0cdcd3036fa2390833af289c7a4f1f341cc5b0cc60b
+  data.tar.gz: e43d31a7c9b32f85d79e3f17463252a15685889c07af38ca85582ecf74c797a8673ce6853eded983cab522a09a83645f9189f869211135053f6427796fea0af4

data/README.md

@@ -1,14 +1,19 @@
-![](https://img.shields.io/badge/ruby-2.3%2B-red.svg)
+![](https://img.shields.io/badge/ruby-2.4%2B-red.svg)
 ![Gem Version](https://img.shields.io/gem/v/camaleon_sitemap_customizer.svg?colorB=blue)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 [![Build Status](https://travis-ci.com/brian-kephart/camaleon_sitemap_customizer.svg?branch=master)](https://travis-ci.com/brian-kephart/camaleon_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.
+This plugin also comes with:
+- an optional sitemap template that includes caching to speed up rendering,
+- links in plugin settings to submit your sitemap to Google,
+- an option to automatically resubmit your sitemap to Google when changes are made (requires ActiveJob).
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -45,7 +50,7 @@ This plugin offers an XML builder template that uses Russian doll caching to spe
 
 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.
+2. Copy the included `app/views/camaleon_cms/default_theme/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/Rakefile

@@ -1,31 +1,33 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'CamaleonSitemapCustomizer'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "CamaleonSitemapCustomizer"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
-load 'rails/tasks/engine.rake'
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
 end
 

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

@@ -1,19 +1,24 @@
+# frozen_string_literal: true
+
 class Plugins::CamaleonSitemapCustomizer::AdminController < CamaleonCms::Apps::PluginsAdminController
   DEFAULT_OPTIONS = {
-    'skip_post_types' => [],
-    'skip_post_list_types' => [],
-    'skip_category_list_types' => [],
-    'skip_all_categories' => false,
-    'skip_tags' => false,
-    'skip_home' => false,
-    'cache' => Rails.env.test? ? true : false
+    "skip_post_types" => [],
+    "skip_post_list_types" => [],
+    "skip_category_list_types" => [],
+    "skip_all_categories" => false,
+    "skip_tags" => false,
+    "skip_home" => false,
+    "cache" => Rails.env.test?,
+    "submit_changes_to_google" => false
   }.freeze
 
   include Plugins::CamaleonSitemapCustomizer::MainHelper
-  def index; end
+  def index
+  end
 
   # show settings form
-  def settings; end
+  def settings
+  end
 
   # save values from settings form
   def save_settings
@@ -21,6 +26,6 @@ class Plugins::CamaleonSitemapCustomizer::AdminController < CamaleonCms::Apps::P
     @plugin.set_options(options) # save option values
     @plugin.set_metas(params[:metas]) if params[:metas].present? # save meta values
     @plugin.set_field_values(params[:field_options]) if params[:field_options].present? # save custom field values
-    redirect_to url_for(action: :settings), notice: 'Settings Saved Successfully'
+    redirect_to url_for(action: :settings), notice: "Settings Saved Successfully"
   end
 end

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

@@ -1,25 +1,35 @@
+# frozen_string_literal: true
+
 module Plugins::CamaleonSitemapCustomizer::MainHelper
+  # methods accessible from views
   def self.included(klass)
-    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+    klass.helper_method [:camaleon_sitemap_customizer_google_submit_url]
+  rescue
+    ""
   end
 
   def camaleon_sitemap_customizer_on_active(plugin)
     skip_posts plugin
   end
 
-  def camaleon_sitemap_customizer_on_inactive(plugin); end
+  def camaleon_sitemap_customizer_on_inactive(plugin)
+  end
 
   def camaleon_sitemap_customizer_on_upgrade(plugin)
     skip_posts plugin
   end
 
   def camaleon_sitemap_customizer_on_plugin_options(args)
-    args[:links] << [link_to('Settings', admin_plugins_camaleon_sitemap_customizer_settings_path), link_to('View Sitemap', '/sitemap', target: :blank)]
+    args[:links] << [
+      link_to("Settings", admin_plugins_camaleon_sitemap_customizer_settings_path),
+      link_to("View Sitemap", cama_sitemap_url, target: :blank),
+      link_to("Submit Sitemap to Google", camaleon_sitemap_customizer_google_submit_url, target: :blank)
+    ]
   end
 
   def customize_sitemap(args)
     # completely excluded content types
-    args[:skip_posttype_ids] += current_plugin.get_option('skip_post_types')&.map(&:to_i).presence || []
+    args[:skip_posttype_ids] += current_plugin.get_option("skip_post_types")&.map(&:to_i).presence || []
     args[:skip_posttype_ids].each do |ptype|
       # leave out post pages within content type
       args[:skip_post_ids] += current_site.the_posts(ptype).map(&:id)
@@ -28,51 +38,64 @@ module Plugins::CamaleonSitemapCustomizer::MainHelper
     end
 
     # excluded list pages
-    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')
+    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 || []
+    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?
+    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?
+    args[:render] = cached_sitemap_template if current_plugin.get_option("cache").present?
   end
 
   def camaleon_sitemap_customizer_form(args)
     args[:extra_settings] << "
       <div class='form-group'>
         <label for='options_hide_in_sitemap' class='control-label'>
-        <input type='checkbox' name='options[hide_in_sitemap]' id='options_hide_in_sitemap' value='true' #{'checked' if args[:post].get_option('hide_in_sitemap').present?}>
-        &nbsp;&nbsp;#{cama_t('hide_in_sitemap')}?
+        <input type='checkbox' name='options[hide_in_sitemap]' id='options_hide_in_sitemap' value='true' #{"checked" if args[:post].get_option("hide_in_sitemap").present?}>
+        &nbsp;&nbsp;#{cama_t("hide_in_sitemap")}?
         </label>
       </div>
     "
   end
 
+  def camaleon_sitemap_customizer_google_submit_url
+    "https://www.google.com/ping?sitemap=#{cama_sitemap_url}"
+  end
+
   def camaleon_sitemap_customizer_save(args)
-    args[:post].set_option 'hide_in_sitemap', false unless params.dig(:options, 'hide_in_sitemap').present?
+    args[:post].set_option "hide_in_sitemap", false unless params.dig(:options, "hide_in_sitemap").present?
     skip_posts current_plugin
   end
 
+  def camaleon_sitemap_customizer_submit_sitemap(_args)
+    plugin = current_site.get_plugin("camaleon_sitemap_customizer").decorate
+    return unless plugin.get_option "submit_changes_to_google"
+    CamaleonSitemapCustomizer::SubmitSitemapJob.perform_later camaleon_sitemap_customizer_google_submit_url
+    flash[:alert] = "Sitemap submitted."
+  rescue => e
+    flash[:alert] = e.message
+  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)
+    plugin.set_option "skip_posts", current_site.the_posts.eager_load(:metas).select { |post| post.get_option("hide_in_sitemap").present? } .map(&:id)
   end
 
   def select_categories
-    if current_plugin.get_option('skip_all_categories').present?
+    if current_plugin.get_option("skip_all_categories").present?
       current_site.the_full_categories.pluck(:id)
     else
-      current_plugin.get_option('skip_category_list_types')&.map(&:to_i).presence || []
+      current_plugin.get_option("skip_category_list_types")&.map(&:to_i).presence || []
     end
   end
 
   def cached_sitemap_template
-    'sitemap_with_caching'
+    "sitemap_with_caching"
   end
 end

data/app/jobs/camaleon_sitemap_customizer/submit_sitemap_job.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class CamaleonSitemapCustomizer::SubmitSitemapJob < ActiveJob::Base
+  queue_as :default
+
+  def perform(submit_url)
+    url = URI.parse submit_url
+    Net::HTTP.get url
+  end
+end

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

@@ -1,23 +1,26 @@
-xml.instruct! :xml, version: '1.0'
-xml.urlset xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9' do
+# frozen_string_literal: true
+
+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'
+      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'
+            xml.changefreq "monthly"
+            xml.priority "0.5"
           end
         end
       end
@@ -26,12 +29,13 @@ xml.urlset xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9' do
     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'
+            xml.changefreq "monthly"
+            xml.priority "0.5"
           end
         end
       end
@@ -40,12 +44,13 @@ xml.urlset xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9' do
     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'
+            xml.changefreq "monthly"
+            xml.priority "0.5"
           end
         end
       end
@@ -54,12 +59,13 @@ xml.urlset xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9' do
     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'
+            xml.changefreq "monthly"
+            xml.priority "0.5"
           end
         end
       end
@@ -72,8 +78,8 @@ xml.urlset xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9' 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'
+          xml.changefreq item[:changefreq] || "monthly"
+          xml.priority item[:priority] || "0.5"
         end
       end
     end

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

@@ -61,7 +61,13 @@
         <%= check_box_tag "options[cache]", 1, @plugin.get_option('cache'), style: 'display: block;' %>
       </div>
 
+      <div class="form-group">
+        <label><%= cama_t 'submit_changes_to_google' %></label>
+        <%= check_box_tag "options[submit_changes_to_google]", 1, @plugin.get_option('submit_changes_to_google'), style: 'display: block;' %>
+      </div>
+
       <div class="form-group text-right">
+        <%= link_to cama_t("submit_sitemap_to_google"), camaleon_sitemap_customizer_google_submit_url, target: :blank %>&nbsp;&nbsp;&nbsp;&nbsp;
         <%= link_to 'View Sitemap', '/sitemap', target: 'blank' %>&nbsp;&nbsp;&nbsp;&nbsp;
         <%= submit_tag 'Save Settings', class: 'btn btn-primary' %>
       </div>

data/config/camaleon_plugin.json

@@ -6,12 +6,15 @@
     "Plugins::CamaleonSitemapCustomizer::MainHelper"
   ],
   "hooks": {
-    "new_post":["camaleon_sitemap_customizer_form"],
-    "edit_post":["camaleon_sitemap_customizer_form"],
-    "updated_post": ["camaleon_sitemap_customizer_save"],
+    "created_post": ["camaleon_sitemap_customizer_submit_sitemap"],
+    "edit_post": ["camaleon_sitemap_customizer_form"],
+    "new_post": ["camaleon_sitemap_customizer_form"],
     "on_active": ["camaleon_sitemap_customizer_on_active"],
     "on_inactive": ["camaleon_sitemap_customizer_on_inactive"],
+    "on_render_sitemap": ["customize_sitemap"],
     "plugin_options": ["camaleon_sitemap_customizer_on_plugin_options"],
-    "on_render_sitemap": ["customize_sitemap"]
+    "restored_post": ["camaleon_sitemap_customizer_submit_sitemap"],
+    "trashed_post": ["camaleon_sitemap_customizer_submit_sitemap"],
+    "updated_post": ["camaleon_sitemap_customizer_save", "camaleon_sitemap_customizer_submit_sitemap"]
   }
 }

data/config/locales/en.yml

@@ -9,3 +9,5 @@ en:
   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?"
+  submit_changes_to_google: "Submit sitemap to Google when changes are made? (requires ActiveJob)"
+  submit_sitemap_to_google: "Submit sitemap to Google"

data/config/routes.rb

@@ -1,12 +1,14 @@
-require 'plugin_routes'
-require 'camaleon_cms/engine'
+# frozen_string_literal: true
+
+require "plugin_routes"
+require "camaleon_cms/engine"
 
 Rails.application.routes.draw do
-  scope PluginRoutes.system_info['relative_url_root'] do
+  scope PluginRoutes.system_info["relative_url_root"] do
     # Admin Panel
-    scope :admin, as: 'admin', path: PluginRoutes.system_info['admin_path_name'] do
-      namespace 'plugins' do
-        namespace 'camaleon_sitemap_customizer' do
+    scope :admin, as: "admin", path: PluginRoutes.system_info["admin_path_name"] do
+      namespace "plugins" do
+        namespace "camaleon_sitemap_customizer" do
           controller :admin do
             get :index
             get :settings

data/lib/camaleon_sitemap_customizer.rb

@@ -1,4 +1,6 @@
-require 'camaleon_sitemap_customizer/engine'
+# frozen_string_literal: true
+
+require "camaleon_sitemap_customizer/engine"
 
 module CamaleonSitemapCustomizer
 end

data/lib/camaleon_sitemap_customizer/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CamaleonSitemapCustomizer
   class Engine < ::Rails::Engine
   end

data/lib/camaleon_sitemap_customizer/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module CamaleonSitemapCustomizer
-  VERSION = '1.0.0'.freeze
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camaleon_sitemap_customizer
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Brian Kephart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-10 00:00:00.000000000 Z
+date: 2020-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: camaleon_cms
@@ -25,33 +25,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.56'
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.13
+        version: 6.0.0
 description: Customize auto-generated sitemap in Camaleon CMS. Eliminate duplicate
   content and list pages.
 email:
@@ -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/jobs/camaleon_sitemap_customizer/submit_sitemap_job.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
@@ -88,15 +89,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Customize auto-generated sitemap in Camaleon CMS