bcms_seo_sitemap 1.0.0

data/LICENSE.txt

@@ -0,0 +1,165 @@
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions. 
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version. 
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README

@@ -0,0 +1,56 @@
+#Sitemaps Module for BrowserCMS
+
+This is  a simple module that generates a basic xml Sitemap for BrowserCMS
+projects. For each published page, it generates the <loc></loc> tag according to the [Sitemap
+protocol](http://www.sitemaps.org/protocol.php) but no metadata.
+
+To determine which pages should be included in the Sitemap, it leverages
+BrowserCMS' menu_items helper. This means that hidden or unpublished pages will
+not be included. Empty sections are also ignored.
+
+The xml document is exposed at /sitemaps/google.xml
+
+## Installation
+
+The blog module installs like most other BrowserCMS modules (http://guides.browsercms.org/installing_modules.html)
+but it does not require a database migration.
+
+    gem install bcms_seo_sitemap
+    
+## Set up your application to use the module
+
+### 1. Edit config/environment.rb 
+    
+    config.gem "browsercms"
+    config.gem "bcms_seo_sitemap"
+    
+### 2. Run the following commands
+  
+    script/generate browser_cms
+  
+### 3. Edit config/routes.rb
+
+Make sure the routes.rb loads the sitemap routes.
+
+    map.routes_for_bcms_seo_sitemap
+    map.routes_for_browser_cms
+
+##Configuration
+
+The module adds a new entry under Administration > Tools labeled XML Sitemaps
+where the module can be configured.
+
+At the moment, only the "depth" option is available, which is passed to the
+menu_items helper method. Setting a depth of 2 will result in a call to menu_items
+like this:
+
+    menu_items(:depth => 2, :show_all_siblings => true, :page => Page.find_by_path('/')
+
+The module's configuration (currently just one value) is serialized to yaml and
+kept in config/sitemap.yml. It is not necessary to create this file manually. It 
+will be created when needed.
+
+A depth value of 0 (the default) will include all published pages.
+
+
+

data/README.markdown

@@ -0,0 +1,12 @@
+#Sitemaps Module for BrowserCMS
+
+This is  a simple module that generates a basic xml Sitemap for BrowserCMS
+projects. For each published page, it generates the <loc></loc> tag according to the [Sitemap
+protocol](http://www.sitemaps.org/protocol.php) but no metadata.
+
+To determine which pages should be included in the Sitemap, it leverages
+BrowserCMS' menu_items helper. This means that hidden or unpublished pages will
+not be included.
+
+The xml document is exposed at /sitemaps/google.xml
+

data/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  protect_from_forgery # See ActionController::RequestForgeryProtection for details
+
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/app/controllers/cms/sitemaps_controller.rb

@@ -0,0 +1,22 @@
+class Cms::SitemapsController < Cms::BaseController 
+
+  layout 'cms/administration'
+
+  check_permissions :administrate
+  before_filter :set_menu_section
+
+  def edit
+    @depth = Cms::SitemapGenerator.depth
+  end
+
+  def update
+    Cms::SitemapGenerator.depth = params[:depth]
+    flash[:notice] = "Sitemap depth updated"
+    redirect_to :action => :edit
+  end
+
+  private
+  def set_menu_section
+    @menu_section = 'xml_sitemaps'
+  end
+end

data/app/controllers/sitemaps_controller.rb

@@ -0,0 +1,9 @@
+class SitemapsController < ApplicationController
+
+  def google
+    @items = Cms::SitemapGenerator.items
+    respond_to do |format|
+      format.xml
+    end
+  end
+end

data/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/app/helpers/cms/sitemaps_helper.rb

@@ -0,0 +1,2 @@
+module Cms::SitemapsHelper
+end

data/app/helpers/sitemaps_helper.rb

@@ -0,0 +1,2 @@
+module SitemapsHelper
+end

data/app/views/cms/shared/_admin_sidebar.html.erb

@@ -0,0 +1,31 @@
+<div class="first">
+  <h3>Users</h3>
+  <ul>
+    <li<%= ' class="open"' if @menu_section == 'users' %>><%= link_to "Users", cms_users_path %></li>
+    <li<%= ' class="open"' if @menu_section == 'groups' %>><%= link_to "Groups", cms_groups_path %></li>
+  </ul>
+</div>
+<div class="bottom_cap bottom_pad"></div>
+
+<div class="top_cap"></div>
+<div>
+  <h3>Templates</h3>
+  <ul>  
+    <li<%= ' class="open"' if @menu_section == 'page_partials' %>><%= link_to "Page Partials", cms_page_partials_path %></li>
+    <li<%= ' class="open"' if @menu_section == 'page_templates' %>><%= link_to "Page Templates", cms_page_templates_path %></li>
+    <li<%= ' class="open"' if @menu_section == 'page_routes' %>><%= link_to "Page Routes", cms_page_routes_path %></li>
+  </ul>
+</div>
+<div class="bottom_cap bottom_pad"></div>
+
+<div class="top_cap"></div>
+<div>
+  <h3>Tools</h3>
+  <ul>  
+    <li<%= ' class="open"' if @menu_section == 'caching' %>><%= link_to "Page Caching", cms_cache_path %></li>
+    <li<%= ' class="open"' if @menu_section == 'redirects' %>><%= link_to "Redirects", cms_redirects_path %></li>
+    <li<%= ' class="open"' if @menu_section == 'email_messages' %>><%= link_to "Email Messages", cms_email_messages_path %></li>
+    <li<%= ' class="open"' if @menu_section == 'xml_sitemaps' %>><%= link_to "XML Sitemaps", cms_xml_sitemaps_path %></li>
+  </ul>
+</div>
+<div class="bottom_cap"></div>

data/app/views/cms/sitemaps/edit.html.erb

@@ -0,0 +1,11 @@
+<%= content_for :html_head, stylesheet_link_tag('cms/form_layout') %>
+<% @page_title = @toolbar_title = "Update Sitemap" %>
+
+<% form_tag cms_xml_sitemaps_path, :method => :put do  %>
+  <div class="fields text_fields">
+    <label for="depth"> Sitemap Depth</label>
+    <%= text_field_tag :depth, @depth %>
+  </div> <div class="buttons">
+    <%= lt_button_wrapper(submit_tag("Update", :class => "submit")) %>
+  </div>
+<% end %>

data/app/views/layouts/templates/default.html.erb

@@ -0,0 +1,17 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
+    <title><%= page_title %></title>
+    <%= yield :html_head %>
+  </head>
+  <body style="margin: 0; padding: 0; text-align: center;">
+    <%= cms_toolbar %>
+    <div id="wrapper" style="width: 700px; margin: 0 auto; text-align: left; padding: 30px">
+      Breadcrumbs: <%= render_breadcrumbs %>
+      Main Menu: <%= render_menu %>
+      <h1><%= page_title %></h1>
+      <%= container :main %>
+    </div>
+  </body>
+</html>

data/app/views/sitemaps/_sitemap_item.xml.erb

@@ -0,0 +1,12 @@
+<% unless sitemap_item[:url] == "#" %>
+  <url>
+    <loc><%= "http://#{request.host}#{sitemap_item[:url]}" %></loc>
+  </url>
+  <% unless sitemap_item[:children].blank? %>
+    <% sitemap_item[:children].each do |item| %>
+      <% unless sitemap_item[:url] == item[:url] || item[:url] == "#" %>
+        <%= render :partial => 'sitemap_item', :object => item %>
+      <% end %>
+    <% end %>
+  <% end %>
+<% end %>

data/app/views/sitemaps/google.xml.erb

@@ -0,0 +1,7 @@
+<?xml version='1.0' encoding='utf-8' ?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" >
+  <% @items.each do |item| %>
+    <%= render :partial => 'sitemap_item', :object => item %>
+  <% end %>
+</urlset>
+

data/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.

data/lib/bcms_seo_sitemap/cms/sitemap_generator.rb

@@ -0,0 +1,35 @@
+module Cms
+  module SitemapGenerator
+    extend self
+    extend Cms::MenuHelper
+
+    CONFIG_PATH = File.join(Rails.root, 'config', 'sitemap.yml')
+
+    def items
+      options = {:page => Page.find_by_path('/'), :show_all_siblings => true}
+      options.merge!(configuration.symbolize_keys!)
+      options.delete(:depth) if configuration[:depth].zero?
+      menu_items(options)
+    end
+
+    def depth=(new_depth)
+      new_config = configuration.merge!({:depth => new_depth.to_i})
+
+      File.open(CONFIG_PATH, 'w') do |out|
+        YAML.dump(new_config, out)
+      end
+    end
+
+    def depth
+      configuration[:depth] || 0
+    end
+
+    private
+
+    def configuration
+      YAML::load(File.open(CONFIG_PATH))
+    rescue Errno::ENOENT
+      {}
+    end
+  end
+end

data/lib/bcms_seo_sitemap/routes.rb

@@ -0,0 +1,9 @@
+module Cms::Routes
+  def routes_for_bcms_seo_sitemap
+    google_sitemap '/sitemaps/google.xml', :controller => 'sitemaps', :action => 'google'
+    namespace :cms do |cms|
+      cms.xml_sitemaps 'xml_sitemaps', :controller => 'sitemaps', :action => 'edit', :conditions => {:method => :get}
+      cms.connect '/xml_sitemaps', :controller => 'sitemaps', :action => 'update' , :conditions => {:method => :put}
+    end
+  end
+end

data/lib/bcms_seo_sitemap.rb

@@ -0,0 +1,2 @@
+require 'bcms_seo_sitemap/routes'
+require 'bcms_seo_sitemap/cms/sitemap_generator'

data/rails/init.rb

@@ -0,0 +1,5 @@
+gem_root = File.expand_path(File.join(File.dirname(__FILE__), ".."))
+Cms.add_to_rails_paths gem_root
+Cms.add_generator_paths gem_root, "db/migrate/[0-9]*_*.rb"
+Cms.add_generator_paths gem_root, "app/views/cms/shared/_admin_sidebar.html.erb"
+Cms.add_generator_paths gem_root, "public/bcms/sitemap/**/*"

data/test/functional/cms/sitemaps_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class Cms::SitemapsControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/functional/sitemaps_controller_test.rb

@@ -0,0 +1,8 @@
+require 'test_helper'
+
+class SitemapsControllerTest < ActionController::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/performance/browsing_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'performance_test_help'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+  def test_homepage
+    get '/'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,38 @@
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
+require 'test_help'
+
+class ActiveSupport::TestCase
+  # Transactional fixtures accelerate your tests by wrapping each test method
+  # in a transaction that's rolled back on completion.  This ensures that the
+  # test database remains unchanged so your fixtures don't have to be reloaded
+  # between every test method.  Fewer database queries means faster tests.
+  #
+  # Read Mike Clark's excellent walkthrough at
+  #   http://clarkware.com/cgi/blosxom/2005/10/24#Rails10FastTesting
+  #
+  # Every Active Record database supports transactions except MyISAM tables
+  # in MySQL.  Turn off transactional fixtures in this case; however, if you
+  # don't care one way or the other, switching from MyISAM to InnoDB tables
+  # is recommended.
+  #
+  # The only drawback to using transactional fixtures is when you actually 
+  # need to test transactions.  Since your test is bracketed by a transaction,
+  # any transactions started in your code will be automatically rolled back.
+  self.use_transactional_fixtures = true
+
+  # Instantiated fixtures are slow, but give you @david where otherwise you
+  # would need people(:david).  If you don't want to migrate your existing
+  # test cases which use the @david style and don't mind the speed hit (each
+  # instantiated fixtures translates to a database query per test method),
+  # then set this back to true.
+  self.use_instantiated_fixtures  = false
+
+  # Setup all fixtures in test/fixtures/*.(yml|csv) for all tests in alphabetical order.
+  #
+  # Note: You'll currently still have to declare fixtures explicitly in integration tests
+  # -- they do not yet inherit this setting
+  fixtures :all
+
+  # Add more helper methods to be used by all tests here...
+end

data/test/unit/helpers/cms/sitemaps_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class Cms::SitemapsHelperTest < ActionView::TestCase
+end

data/test/unit/helpers/sitemaps_helper_test.rb

@@ -0,0 +1,4 @@
+require 'test_helper'
+
+class SitemapsHelperTest < ActionView::TestCase
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification 
+name: bcms_seo_sitemap
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- BrowserMedia
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-24 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: browsercms
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+description: This module generates XML Sitemaps for BrowserCMS Projects
+email: github@browsermedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+- README.markdown
+files: 
+- app/controllers/application_controller.rb
+- app/controllers/cms/sitemaps_controller.rb
+- app/controllers/sitemaps_controller.rb
+- app/helpers/application_helper.rb
+- app/helpers/cms/sitemaps_helper.rb
+- app/helpers/sitemaps_helper.rb
+- app/views/cms/shared/_admin_sidebar.html.erb
+- app/views/cms/sitemaps/edit.html.erb
+- app/views/layouts/templates/default.html.erb
+- app/views/sitemaps/_sitemap_item.xml.erb
+- app/views/sitemaps/google.xml.erb
+- doc/README_FOR_APP
+- lib/bcms_seo_sitemap.rb
+- lib/bcms_seo_sitemap/cms/sitemap_generator.rb
+- lib/bcms_seo_sitemap/routes.rb
+- rails/init.rb
+- LICENSE.txt
+- README
+- README.markdown
+- test/functional/cms/sitemaps_controller_test.rb
+- test/functional/sitemaps_controller_test.rb
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/helpers/cms/sitemaps_helper_test.rb
+- test/unit/helpers/sitemaps_helper_test.rb
+has_rdoc: true
+homepage: https://github.com/browsermedia/bcms_seo_sitemap
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Sitemap Module for BrowserCMS
+test_files: 
+- test/functional/cms/sitemaps_controller_test.rb
+- test/functional/sitemaps_controller_test.rb
+- test/performance/browsing_test.rb
+- test/test_helper.rb
+- test/unit/helpers/cms/sitemaps_helper_test.rb
+- test/unit/helpers/sitemaps_helper_test.rb