camaleon_sitemap_customizer 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6be96407242f8ed63430807b32391796d6f23b879611546f3447e35d3ebedf5a
-  data.tar.gz: f50b123ba4d294c33745153fdeea8325c7ef1c2dcc512e75bd20b510281a084e
+  metadata.gz: 044b819320b8c634f74f959e3efc63992fd462b0e3d9ae9843f6f5c98e3b34cb
+  data.tar.gz: 92ec9e59355e9dd61e7b24e610a328937d1d418c88bc6d111ab021f4f4ba6edc
 SHA512:
-  metadata.gz: 3e5398a02f510d9aae7260322ffe922fa11b91d0e13cf086661851c70bd662d722871475c5648698c56aa49051ef9ddcbd9b37d0d8661eebefb7cd3ac78f86ab
-  data.tar.gz: b2f98783bcf07fc91623bb2ea0c3a2c5ed8a0b9d32377ff96e3d1333978f56314a5cfac8ce967f10d93c1bf7058ab28920b9adcb39f2faaf6deeeb01491f0f76
+  metadata.gz: 9f68a337bcb208a34d1b9871c3eecd679c79528344810dccc352cf70d18f757294f52fc97846b0976b1e7ee57cf274770a50ab2faa573fb5bd128d59c133fcbf
+  data.tar.gz: db02eccb4dc720e528009c6baae6c49b036dbbb5014bb09bad2bca44aafb23d298aa041c9eeb43d91bf6975baac5a89069bc2e65b274c266e8dade18e8e536d3

data/README.md

@@ -1,14 +1,10 @@
-# 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.
+[![Build Status](https://travis-ci.com/brian-kephart/camaleon_sitemap_customizer.svg?branch=master)](https://travis-ci.com/brian-kephart/camaleon_sitemap_customizer)
 
-Use the site settings (/admin/plugins/camaleon_sitemap_customizer/settings) to:
-- Select **content types** to exclude **completely** (individual posts and list pages).
-- Select **content types** for which to exclude **list pages only**. For example, if you have a content type called 'Podcast', this option would allow you to exclude 'http://yoursite.com/podcast' (the page listing all posts of type 'Podcast') without excluding the pages for each individual post.
-- 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.
-
-This plugin (as of version 0.3.0) 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.
+# 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')
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -27,12 +23,18 @@ Or install it yourself as:
 $ gem install camaleon_sitemap_customizer
 ```
 
+## Usage
+Use the site settings (/admin/plugins/camaleon_sitemap_customizer/settings) to:
+- Select **content types** to exclude **completely** (individual posts and list pages).
+- Select **content types** for which to exclude **list pages only**. For example, if you have a content type called 'Podcast', this option would allow you to exclude 'http://yoursite.com/podcast' (the page listing all posts of type 'Podcast') without excluding the pages for each individual post.
+- 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.
+
+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.
+
 ## Contributing
-- Fork it.
-- Create a branch (git checkout -b my_feature_branch)
-- Commit your changes (git commit -am "Added a sweet feature")
-- Push to the branch (git push origin my_feature_branch)
-- Create a pull request from your branch into master (Please be sure to provide enough detail for us to cipher what this change is doing)
+See CONTRIBUTING.md
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -14,14 +14,11 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 load 'rails/tasks/engine.rake'
 
-
 load 'rails/tasks/statistics.rake'
 
-
-
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'
@@ -32,5 +29,4 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = false
 end
 
-
 task default: :test

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

@@ -1,22 +1,23 @@
 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
+  }.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
-    params[:options]                             ||= {}
-    params[:options]['skip_post_types']          ||= []
-    params[:options]['skip_post_list_types']     ||= []
-    params[:options]['skip_category_list_types'] ||= []
-    params[:options]['skip_all_categories']      ||= false
-    params[:options]['skip_tags']                ||= false
-    params[:options]['skip_home']                ||= false
-    @plugin.set_options(params[:options]) # save option values
+    options = DEFAULT_OPTIONS.merge(params[:options]&.to_unsafe_h.presence || {})
+    @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'

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

@@ -4,41 +4,35 @@ module Plugins::CamaleonSitemapCustomizer::MainHelper
   end
 
   def camaleon_sitemap_customizer_on_active(plugin)
-    set_skip_posts 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)
-    set_skip_posts 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)]
   end
 
-  def customize_sitemap(r)
-
+  def customize_sitemap(args)
     # completely excluded content types
-    r[:skip_posttype_ids] += current_plugin.get_option('skip_post_types').map(&:to_i) rescue nil
-    r[:skip_posttype_ids].each do |ptype|
+    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
-      current_site.the_posts(ptype).each do |post|
-        r[:skip_post_ids] += [post.id]
-      end
+      args[:skip_post_ids] += current_site.the_posts(ptype).map(&:id)
       # leave out category pages within content type
-      current_site.the_categories(ptype).each do |cat|
-        r[:skip_cat_ids] += [cat.id]
-      end
+      args[:skip_cat_ids] += current_site.the_categories(ptype).map(&:id)
     end
 
     # excluded list pages
-    r[:skip_posttype_ids] += current_plugin.get_option('skip_post_list_types').map(&:to_i) rescue []
-    r[:skip_cat_ids]      += select_categories
-    r[:skip_tag_ids]      += current_site.the_tags.map(&:id)   if current_plugin.get_option('skip_tags')
-    r[:skip_post_ids]     += [@_site_options[:home_page].to_i] if current_plugin.get_option('skip_home')
-    r[:skip_post_ids]     += current_plugin.get_option('skip_posts').presence || []
+    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_post_ids]     += current_plugin.get_option('skip_posts').presence || []
+    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?
   end
 
   def camaleon_sitemap_customizer_form(args)
@@ -53,19 +47,19 @@ module Plugins::CamaleonSitemapCustomizer::MainHelper
   end
 
   def camaleon_sitemap_customizer_save(args)
-    args[:post].set_option 'hide_in_sitemap', nil unless params.dig(:options, 'hide_in_sitemap').present?
-    set_skip_posts current_plugin
+    args[:post].set_option 'hide_in_sitemap', false unless params.dig(:options, 'hide_in_sitemap').present?
+    skip_posts current_plugin
   end
 
-  def set_skip_posts(plugin)
+  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
 
   def select_categories
-    current_plugin.get_option('skip_all_categories').present? ?
-    current_site.the_full_categories.pluck(:id) :
-    current_plugin.get_option('skip_category_list_types').map(&:to_i)
-  rescue
-    []
+    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 || []
+    end
   end
 end

data/config/routes.rb

@@ -1,17 +1,19 @@
-Rails.application.routes.draw do
+require 'plugin_routes'
+require 'camaleon_cms/engine'
 
-    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
-            controller :admin do
-              get :index
-              get :settings
-              post :save_settings
-            end
+Rails.application.routes.draw 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
+          controller :admin do
+            get :index
+            get :settings
+            post :save_settings
           end
         end
       end
     end
   end
+end

data/lib/camaleon_sitemap_customizer.rb

@@ -1,4 +1,4 @@
-require "camaleon_sitemap_customizer/engine"
+require 'camaleon_sitemap_customizer/engine'
 
 module CamaleonSitemapCustomizer
 end

data/lib/camaleon_sitemap_customizer/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: camaleon_sitemap_customizer
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Brian Kephart
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-01 00:00:00.000000000 Z
+date: 2018-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: camaleon_cms
@@ -24,6 +24,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.56'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.13
 description: Customize auto-generated sitemap in Camaleon CMS. Eliminate duplicate
   content and list pages.
 email:
@@ -57,9 +85,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -67,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Customize auto-generated sitemap in Camaleon CMS