camaleon_sitemap_customizer 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c811fdeb76df68e0ff79dc06991a947c325442d5d4eaae6703af3ae3016aa4cd
+  data.tar.gz: 8735cfdde7084d4473f1eca60110e1af927e400260c87f66adb9b2465f64b740
+SHA512:
+  metadata.gz: 38fc9000151254d987360df212d56f7b5dacb438186c97d0fd16652a9a6dfa8b5bc61fa6eb1a32b61d7eebcdbae8268d735d639ca2be37766739b2c92c4d2645
+  data.tar.gz: e4bd85c065982624d9aa3256c97539614521c46d4eb41cd9d2e8b681828739283cadd5f825a008e7b5aa2a6af58267e7d6dcf73878f47350fdb63fe7bccc359f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Brian Kephart
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,38 @@
+# 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.
+
+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.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'camaleon_sitemap_customizer', git: 'https://github.com/brian-kephart/camaleon_sitemap_customizer.git'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install camaleon_sitemap_customizer
+```
+
+## 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)
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+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')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

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

@@ -0,0 +1,24 @@
+class Plugins::CamaleonSitemapCustomizer::AdminController < CamaleonCms::Apps::PluginsAdminController
+  include Plugins::CamaleonSitemapCustomizer::MainHelper
+  def index
+  end
+
+  # show settings form
+  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
+    @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'
+  end
+end

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

@@ -0,0 +1,71 @@
+module Plugins::CamaleonSitemapCustomizer::MainHelper
+  def self.included(klass)
+    # klass.helper_method [:my_helper_method] rescue "" # here your methods accessible from views
+  end
+
+  def camaleon_sitemap_customizer_on_active(plugin)
+    set_skip_posts plugin
+  end
+
+  def camaleon_sitemap_customizer_on_inactive(plugin)
+  end
+
+  def camaleon_sitemap_customizer_on_upgrade(plugin)
+    set_skip_posts plugin
+  end
+
+  def camaleon_sitemap_customizer_on_plugin_options(args)
+    args[:links] << link_to('Settings', admin_plugins_camaleon_sitemap_customizer_settings_path)
+  end
+
+  def customize_sitemap(r)
+
+    # 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|
+      # leave out post pages within content type
+      current_site.the_posts(ptype).each do |post|
+        r[:skip_post_ids] += [post.id]
+      end
+      # leave out category pages within content type
+      current_site.the_categories(ptype).each do |cat|
+        r[:skip_cat_ids] += [cat.id]
+      end
+    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 || []
+  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')}?
+        </label>
+      </div>
+    "
+  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
+  end
+
+  def set_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
+    []
+  end
+end

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

@@ -0,0 +1,67 @@
+<script>
+  jQuery(function($){
+    var form = $("#cache_front_form");
+    form.find("#btn-add-path").click(function(){
+      var a = '<div class="input-group"> <input name="cache[paths][]" type="text" class="form-control" value=""> <span class="input-group-addon border_trans"><i class="round_icon fa fa-times text-danger del_path "></i></span> </div>';
+      form.find("#paths").append(a);
+      return false;
+    });
+    form.on("click", ".del_path", function(){
+      $(this).closest(".input-group").remove();
+    });
+    $('#camaleon_sitemap_customizer_form select').selectpicker();
+  });
+</script>
+
+<div class="panel panel-default">
+  <div class="panel-heading">
+    <h4><%= cama_t 'sitemap_settings' %></h4>
+  </div>
+
+  <div class="panel-body">
+
+    <div class="alert alert-info">
+      <%== cama_t 'instructions' %>
+    </div>
+
+    <%= form_tag url_for(action: :save_settings), id: 'camaleon_sitemap_customizer_form', class: 'validate' do %>
+
+      <div class="form-group">
+      <label><%= cama_t 'content_types_complete' %></label>
+        <%= select_tag "options[skip_post_types]", options_from_collection_for_select(current_site.post_types.decorate, "id", "the_title", @plugin.get_option('skip_post_types')), class: "form-control select", multiple: true, "data-live-search" => true %>
+      </div>
+
+      <div class="form-group">
+        <label><%= cama_t 'content_types_list' %></label>
+        <%= select_tag "options[skip_post_list_types]", options_from_collection_for_select(current_site.post_types.decorate, "id", "the_title", @plugin.get_option('skip_post_list_types')), class: "form-control select", multiple: true, "data-live-search" => true %>
+      </div>
+
+      <div class="form-group">
+          <label><%= cama_t 'categories_list' %></label>
+          <%= select_tag "options[skip_category_list_types]", options_from_collection_for_select(current_site.the_full_categories.decorate, "id", "the_title", @plugin.get_option('skip_category_list_types')), class: "form-control select", multiple: true, "data-live-search" => true %>
+      </div>
+
+      <div class="form-group">
+        <label><%= cama_t 'categories_all' %>?</label>
+        <%= check_box_tag "options[skip_all_categories]", 1, @plugin.get_option('skip_all_categories'), style: 'display: block;' %>
+      </div>
+
+      <div class="form-group">
+        <label><%= cama_t 'tags' %>?</label>
+        <%= check_box_tag "options[skip_tags]", 1, @plugin.get_option('skip_tags'), style: 'display: block;' %>
+      </div>
+
+      <div class="form-group">
+        <label><%= cama_t 'homepage' %></label>
+        <%= check_box_tag "options[skip_home]", 1, @plugin.get_option('skip_home'), style: 'display: block;' %>
+      </div>
+
+
+      <div class="form-group text-right">
+        <%= link_to 'View Sitemap', '/sitemap', target: 'blank' %>&nbsp;&nbsp;&nbsp;&nbsp;
+        <%= submit_tag 'Save Settings', class: 'btn btn-primary' %>
+      </div>
+
+    <% end %>
+  </div>
+</div>

data/config/camaleon_plugin.json

@@ -0,0 +1,17 @@
+{
+  "title": "Camaleon Sitemap Customizer",
+  "descr": "Alter the auto-generated sitemap in Camaleon CMS",
+  "key": "camaleon_sitemap_customizer",
+  "helpers": [
+    "Plugins::CamaleonSitemapCustomizer::MainHelper"
+  ],
+  "hooks": {
+    "new_post":["camaleon_sitemap_customizer_form"],
+    "edit_post":["camaleon_sitemap_customizer_form"],
+    "updated_post": ["camaleon_sitemap_customizer_save"],
+    "on_active": ["camaleon_sitemap_customizer_on_active"],
+    "on_inactive": ["camaleon_sitemap_customizer_on_inactive"],
+    "plugin_options": ["camaleon_sitemap_customizer_on_plugin_options"],
+    "on_render_sitemap": ["customize_sitemap"]
+  }
+}

data/config/locales/en.yml

@@ -0,0 +1,10 @@
+en:
+  sitemap_settings: "Sitemap Settings"
+  hide_in_sitemap: "Hide in Sitemap"
+  instructions: "Camaleon CMS automatically generates a sitemap. Select the content types you wish to <b>exclude</b> from this sitemap. You can also exclude individual posts by using the post editor."
+  content_types_complete: "Content Types to exclude completely"
+  content_types_list: "Content Types to exclude (list pages only)"
+  categories_list: "Categories to exclude (list pages only)"
+  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)"

data/config/routes.rb

@@ -0,0 +1,17 @@
+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/engine.rb

@@ -0,0 +1,4 @@
+module CamaleonSitemapCustomizer
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/camaleon_sitemap_customizer/version.rb

@@ -0,0 +1,3 @@
+module CamaleonSitemapCustomizer
+  VERSION = '0.4.0'
+end

data/lib/camaleon_sitemap_customizer.rb

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: camaleon_sitemap_customizer
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Brian Kephart
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: camaleon_cms
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Customize auto-generated sitemap in Camaleon CMS
+email:
+- briantkephart@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/controllers/plugins/camaleon_sitemap_customizer/admin_controller.rb
+- app/helpers/plugins/camaleon_sitemap_customizer/main_helper.rb
+- app/views/plugins/camaleon_sitemap_customizer/admin/settings.html.erb
+- config/camaleon_plugin.json
+- config/locales/en.yml
+- config/routes.rb
+- lib/camaleon_sitemap_customizer.rb
+- lib/camaleon_sitemap_customizer/engine.rb
+- lib/camaleon_sitemap_customizer/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: Customize auto-generated sitemap in Camaleon CMS
+test_files: []