bcms_seo_sitemap 1.0.0 → 1.0.1

data/README.markdown

@@ -1,12 +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.
+projects. For each published page, it generates the `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.
+not be included. Empty sections are also ignored.
 
 The xml document is exposed at /sitemaps/google.xml
 
+## Installation
+
+The Seo Sitemap 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/app/views/sitemaps/_sitemap_item.xml.erb

@@ -1,6 +1,6 @@
 <% unless sitemap_item[:url] == "#" %>
   <url>
-    <loc><%= "http://#{request.host}#{sitemap_item[:url]}" %></loc>
+    <loc><%= CGI.escapeHTML("http://#{request.host}#{sitemap_item[:url]}") %></loc>
   </url>
   <% unless sitemap_item[:children].blank? %>
     <% sitemap_item[:children].each do |item| %>

data/db/migrate/20101129011429_create_cms_modules.rb

@@ -0,0 +1,14 @@
+class CreateCmsModules < ActiveRecord::Migration
+  def self.up
+    create_table :cms_modules do |t|
+      t.string :name, :limit => 50
+      t.text :settings
+      t.boolean :cms_managed, :default => true
+    end
+  end
+
+  def self.down
+    drop_table :cms_modules
+  end
+end
+

data/lib/bcms_seo_sitemap/cms/sitemap_generator.rb

@@ -3,33 +3,34 @@ module Cms
     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?
+      if configuration.depth && configuration.depth.nonzero?
+        options.merge!({:depth => configuration.depth})
+      end
       menu_items(options)
     end
 
+    # These setter and getter methods are probably not needed anymore.
+    # Access to Cms::Settings.bcms_seo_sitemap could be done directly
+    # from Cms::SitemapsController and that would probably be cleaner.
+    #
+    # I'm keeping them here to keep the changes contained to this file
+    # only for now.
     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
+      configuration.depth = new_depth.to_i
     end
 
+    # If depth has never been set, it returns nil
     def depth
-      configuration[:depth] || 0
+      configuration.depth || 0
     end
 
     private
 
     def configuration
-      YAML::load(File.open(CONFIG_PATH))
-    rescue Errno::ENOENT
-      {}
+      Cms::Settings.bcms_seo_sitemap
     end
   end
 end
+

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bcms_seo_sitemap
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - BrowserMedia
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-24 00:00:00 -06:00
+date: 2010-11-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,14 +24,32 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 7
         segments: 
-        - 0
-        version: "0"
-  type: :development
+        - 3
+        - 1
+        - 2
+        version: 3.1.2
+  type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: bcms_settings
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 29
+        segments: 
+        - 0
+        - 0
+        - 1
+        version: 0.0.1
+  type: :runtime
+  version_requirements: *id002
 description: This module generates XML Sitemaps for BrowserCMS Projects
 email: github@browsermedia.com
 executables: []
@@ -40,7 +58,6 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README
 - README.markdown
 files: 
 - app/controllers/application_controller.rb
@@ -54,13 +71,13 @@ files:
 - app/views/layouts/templates/default.html.erb
 - app/views/sitemaps/_sitemap_item.xml.erb
 - app/views/sitemaps/google.xml.erb
+- db/migrate/20101129011429_create_cms_modules.rb
 - 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

data/README

@@ -1,56 +0,0 @@
-#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.
-
-
-