spree_sitemap_generator 3.0.2 → 3.0.3

data/LICENSE

@@ -1,14 +1,17 @@
-Redistribution and use in source and binary forms, with or without modification, 
+Copyright (c) 2011 Joshua Nussbaum 
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
 
-    * Redistributions of source code must retain the above copyright notice, 
+    * Redistributions of source code must retain the above copyright notice,
       this list of conditions and the following disclaimer.
-    * Redistributions in binary form must reproduce the above copyright notice, 
-      this list of conditions and the following disclaimer in the documentation 
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.
-    * Neither the name of the Rails Dog LLC nor the names of its 
-      contributors may be used to endorse or promote products derived from this 
-      software without specific prior written permission.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
@@ -20,4 +23,4 @@ PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -6,25 +6,57 @@ Spree sitemap generator is a sitemap generator based on the sitemap_generator ge
 Installation
 =======
 
-  gem install spree-sitemap-generator
+1) add the gem to your `Gemfile`:
 
-Example goes here.
+`gem 'spree_sitemap_generator'`
 
-Setup
-======
+2) run bundler:
 
-  echo "public/sitemap*" >> .gitignore
+`bundle install`
+
+3) run the installer, it will create a `config/sitemap.rb` file with some sane defaults
+
+`rails generate spree_sitemap_generator:install`
+
+4) add sitemap to your `.gitignore`
+
+`echo "public/sitemap*" >> .gitignore`
+
+5) setup a daily cron job to regenrate your sitemap via the `rake sitemap:refresh` task. If you use the Whenever gem, add this to your `config/schedule.rb`
+
+```
+every 1.day, :at => '5:00 am' do
+  rake "-s sitemap:refresh"
+end
+```
+
+6) make sure crawlers can find the sitemap, by adding the following line to your `public/robots.txt` with your correct domain name
+
+`echo "Sitemap: http://www.example.com/sitemap_index.xml.gz" >> public/robots.txt`
+
+
+7) BOOM you're done!
+
+More Configuration Options
+==========================
+
+Check out the README for the sitemap_generator gem at:
+http://github.com/kjvarga/sitemap_generator
 
 Features
 =====
 - Notifies search engine of new sitemaps (Google, Yahoo, Ask, Bing)
+- Supports large huge product catalogs
+- Adheres to 0.9 Sitemap protocol specification
 - Compresses sitemaps with gzip
-- Provides basic sitemap of a Spree site
-- Allows you to easily add additional sitemaps for pages you add to your site
-
+- Provides basic sitemap of a Spree site (products, taxons, login page, signup page)
+- Easily add additional sitemaps for pages you add to your spree site
+- Supports Amazon S3 and other hosting services
+- Thin wrapper over battle tested sitemap generator
 
 Special Thanks
 =====
+- The creators of the sitemap_generator gem
+- jackkinsella
 
-
-Copyright (c) 2010 [name of extension creator], released under the New BSD License
+Copyright (c) 2011 Joshua Nussbaum, released under the New BSD License

data/lib/generators/templates/config/sitemap.rb

@@ -1,3 +1,5 @@
+SitemapGenerator::Sitemap.default_host = "http://#{Spree::Config[:site_url]}"
+
 SitemapGenerator::Sitemap.add_links do |sitemap|
   # Put links creation logic here.
   #

data/lib/spree_sitemap_generator.rb

@@ -1,37 +1,3 @@
 require 'spree_core'
-require 'spree_sitemap_generator_hooks'
 require 'sitemap_generator'
-
-module SpreeSitemapGenerator
-  class Engine < Rails::Engine
-
-    config.autoload_paths += %W(#{config.root}/lib)
-
-    def self.activate
-
-      ActiveRecord::Relation.class_eval do
-        def last_updated
-          last_update = order('updated_at DESC').first
-          last_update.try(:updated_at) 
-        end 
-      end
-
-      ActiveRecord::Base.class_eval do
-        def self.last_updated
-          scoped.last_updated
-        end
-      end
-
-      SitemapGenerator::Sitemap.default_host = "http://#{Spree::Config[:site_url]}"
-
-      require 'spree_sitemap_generator/spree_defaults'
-      SitemapGenerator::LinkSet.send :include, SpreeSitemapGenerator::SpreeDefaults
-
-      Dir.glob(File.join(File.dirname(__FILE__), "../app/**/*_decorator*.rb")) do |c|
-        Rails.env.production? ? require(c) : load(c)
-      end
-    end
-
-    config.to_prepare &method(:activate).to_proc
-  end
-end
+require 'spree_sitemap_generator/engine'

data/lib/spree_sitemap_generator/engine.rb

@@ -0,0 +1,40 @@
+module SpreeSitemapGenerator
+  class Engine < Rails::Engine
+    engine_name 'spree_sitemap_generator'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      ActiveRecord::Relation.class_eval do
+        def last_updated
+          last_update = order('updated_at DESC').first
+          last_update.try(:updated_at) 
+        end 
+      end
+
+      ActiveRecord::Base.class_eval do
+        def self.last_updated
+          scoped.last_updated
+        end
+      end
+
+      require 'spree_sitemap_generator/spree_defaults'
+      SitemapGenerator::Interpreter.send :include, SpreeSitemapGenerator::SpreeDefaults
+
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_sitemap_generator/spree_defaults.rb

@@ -1,6 +1,6 @@
 module SpreeSitemapGenerator::SpreeDefaults
   def default_url_options
-    {:host => URI.parse(SitemapGenerator::Sitemap.default_host).host}
+    {:host => SitemapGenerator::Sitemap.default_host}
   end 
   include ::Rails.application.routes.url_helpers
 
@@ -17,7 +17,7 @@ module SpreeSitemapGenerator::SpreeDefaults
   end
 
   def add_password_reset(options={})
-    add(new_password_reset_path, options)
+    add(new_user_password_path, options)
   end
 
   def add_products(options={})

metadata

@@ -1,107 +1,75 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: spree_sitemap_generator
-version: !ruby/object:Gem::Version 
-  hash: 3
-  prerelease: false
-  segments: 
-  - 3
-  - 0
-  - 2
-  version: 3.0.2
+version: !ruby/object:Gem::Version
+  version: 3.0.3
+  prerelease: 
 platform: ruby
-authors: []
-
+authors:
+- Joshua Nussbaum
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-06 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-10-24 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: spree_core
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &84319750 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 101
-        segments: 
-        - 0
-        - 30
-        - 1
-        version: 0.30.1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.70.0
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: sitemap_generator
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *84319750
+- !ruby/object:Gem::Dependency
+  name: sitemap_generator
+  requirement: &84319300 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 3
-        - 4
-        version: 1.3.4
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.1
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *84319300
 description: 
-email: 
+email: joshnuss@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.md
 - LICENSE
-- lib/spree_sitemap_generator.rb
 - lib/tasks/spree_sitemap_generator.rake
-- lib/spree_sitemap_generator/spree_defaults.rb
-- lib/spree_sitemap_generator_hooks.rb
-- lib/generators/templates/config/sitemap.rb
 - lib/generators/spree_sitemap_generator/install_generator.rb
-has_rdoc: true
+- lib/generators/templates/config/sitemap.rb
+- lib/spree_sitemap_generator.rb
+- lib/spree_sitemap_generator/engine.rb
+- lib/spree_sitemap_generator/spree_defaults.rb
 homepage: 
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+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: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-requirements: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
 - none
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Add gem summary here
+summary: Provides a sitemap file for Spree
 test_files: []
-

data/lib/spree_sitemap_generator_hooks.rb

@@ -1,3 +0,0 @@
-class SpreeSitemapGeneratorHooks < Spree::ThemeSupport::HookListener
-  # custom hooks go here
-end