bcms_seo_sitemap 1.0.3 → 1.1.0

data/app/controllers/application_controller.rb

@@ -1,10 +1,3 @@
-# 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
+  protect_from_forgery
 end

data/app/controllers/cms/sitemaps_controller.rb

@@ -6,11 +6,11 @@ class Cms::SitemapsController < Cms::BaseController
   before_filter :set_menu_section
 
   def edit
-    @depth = Cms::SitemapGenerator.depth
+    @depth = BcmsSeoSitemap::Generator.depth
   end
 
   def update
-    Cms::SitemapGenerator.depth = params[:depth]
+    BcmsSeoSitemap::Generator.depth = params[:depth]
     flash[:notice] = "Sitemap depth updated"
     redirect_to :action => :edit
   end

data/app/controllers/sitemaps_controller.rb

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

data/app/helpers/application_helper.rb

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

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

@@ -1,4 +1,4 @@
-<% unless sitemap_item[:url] == "#" || sitemap_item[:url].first != '/' %>
+<% unless sitemap_item[:url] == "#" %>
   <url>
     <loc><%= CGI.escapeHTML("http://#{request.host}#{sitemap_item[:url]}") %></loc>
   </url>

data/lib/bcms_seo_sitemap.rb

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

data/lib/bcms_seo_sitemap/engine.rb

@@ -0,0 +1,12 @@
+require 'browsercms'
+
+module BcmsSeoSitemap
+  class Engine < Rails::Engine
+    include Cms::Module
+    
+    initializer "bcms_seo_sitemap.require_classes"do      
+      # Need to have loaded all BrowserCMS app directories first before we can reference classes there.
+      require 'bcms_seo_sitemap/generator'
+    end
+  end
+end

data/lib/bcms_seo_sitemap/{cms/sitemap_generator.rb → generator.rb}

@@ -1,5 +1,7 @@
-module Cms
-  module SitemapGenerator
+require 'bcms_settings/cms/settings'
+
+module BcmsSeoSitemap
+  module Generator
     extend self
     extend Cms::MenuHelper
 
@@ -8,7 +10,9 @@ module Cms
       if configuration.depth && configuration.depth.nonzero?
         options.merge!({:depth => configuration.depth})
       end
-      menu_items(options)
+      items = menu_items(options)
+      return [] unless items
+      items
     end
 
     # These setter and getter methods are probably not needed anymore.

data/lib/bcms_seo_sitemap/routes.rb

@@ -1,9 +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}
+    match '/sitemaps/google.xml'=>'sitemaps#google', :as =>:google_sitemap
+    namespace :cms do 
+      get '/xml_sitemaps'=>'sitemaps#edit', :as =>:xml_sitemaps
+      put '/xml_sitemaps'=>'sitemaps#update', :as =>:xml_sitemaps
     end
   end
 end

data/lib/bcms_seo_sitemap/version.rb

@@ -0,0 +1,3 @@
+module BcmsSeoSitemap
+  VERSION = "1.1.0"
+end

data/lib/generators/bcms_seo_sitemap/install/USAGE

@@ -0,0 +1,10 @@
+Description:
+    Installs the bcms_seo_sitemap module.
+
+Example:
+    rails generate bcms_seo_sitemap:install
+
+    This will:
+		1. Copy any migrations from the gem into the project.
+		2. Add the routes to the config/routes.rb
+

data/lib/generators/bcms_seo_sitemap/install/install_generator.rb

@@ -0,0 +1,10 @@
+require 'cms/module_installation'
+
+class BcmsSeoSitemap::InstallGenerator < Cms::ModuleInstallation
+  add_migrations_directory_to_source_root __FILE__
+
+  # Add migrations to be copied, by uncommenting the following file and editing as needed.
+  # copy_migration_file 'name_of_migration'
+
+  
+end

metadata

@@ -1,65 +1,44 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: bcms_seo_sitemap
-version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - BrowserMedia
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-12-09 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-06 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: browsercms
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70341872264300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 1
-        - 2
-        version: 3.1.2
+      - !ruby/object:Gem::Version
+        version: 3.3.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: bcms_settings
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *70341872264300
+- !ruby/object:Gem::Dependency
+  name: bcms_settings
+  requirement: &70341872263300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
+    requirements:
     - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 0
-        - 0
-        - 1
-        version: 0.0.1
+      - !ruby/object:Gem::Version
+        version: 0.1.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *70341872263300
 description: This module generates XML Sitemaps for BrowserCMS Projects
 email: github@browsermedia.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE.txt
-- README.markdown
-files: 
+extra_rdoc_files: []
+files:
 - app/controllers/application_controller.rb
 - app/controllers/cms/sitemaps_controller.rb
 - app/controllers/sitemaps_controller.rb
@@ -71,58 +50,42 @@ 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/engine.rb
+- lib/bcms_seo_sitemap/generator.rb
 - lib/bcms_seo_sitemap/routes.rb
-- rails/init.rb
-- LICENSE.txt
-- 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
+- lib/bcms_seo_sitemap/version.rb
+- lib/bcms_seo_sitemap.rb
+- lib/generators/bcms_seo_sitemap/install/install_generator.rb
+- lib/generators/bcms_seo_sitemap/install/USAGE
 homepage: https://github.com/browsermedia/bcms_seo_sitemap
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -2786865705532350108
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -2786865705532350108
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.3.7
+rubyforge_project: bcms_seo_sitemap
+rubygems_version: 1.8.10
 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
+test_files: []

data/LICENSE.txt

@@ -1,165 +0,0 @@
-		   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.markdown

@@ -1,63 +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` 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 Seo Sitemap module installs like most other BrowserCMS modules.
-You'll also need to install the [Settings module](https://github.com/browsermedia/bcms_settings)
-which Seo Sitemap uses to write configuration values. Setting up both modules at
-once is easy though:
-
-    gem install bcms_seo_sitemap # This will install the settings gem as well.
-
-## Set up your application to use the module
-
-### 1. Edit config/environment.rb
-
-    config.gem "browsercms"
-    config.gem "bcms_settings"
-    config.gem "bcms_seo_sitemap"
-
-### 2. Run the following commands
-
-    script/generate browser_cms
-    rake db:migrate
-
-### 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
-
-### 4. Add the following line to the browsercms.rb initializer
-
-    Cms::Settings.synchronize
-
-##Configuration
-
-The module adds a new entry under Administration > Tools labeled "Google
-Sitemap" 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 written to a global key
-value store provided by the Settings module. 
-
-A depth value of 0 (the default) will include all published pages.
-
-
-

data/db/migrate/20101129011429_create_cms_modules.rb

@@ -1,14 +0,0 @@
-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/rails/init.rb

@@ -1,5 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,38 +0,0 @@
-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

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

data/test/unit/helpers/sitemaps_helper_test.rb

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