spree_dynamic_sitemaps 0.50.0

data/README.markdown

@@ -0,0 +1,32 @@
+SUMMARY
+=======
+
+This Spree extension generates dynamic, seo-friendly sitemaps on the fly in html, xml and txt formats.
+
+This extension is compatible with the [static_content][1] extension and will check for content in the Page table.
+
+In order to avoid an seo penalty for duplicate content, products are only listed once at /product/_productName_
+
+for rails 3 and spree >= 0.30.0
+
+INSTALLATION
+------------
+
+1. Install the extension
+
+	gem 'dynamic_sitemaps', :git => 'git://github.com/bzt/spree_dynamic_sitemaps.git' 
+	bundle install 
+	
+	(rake dynamic_sitemaps:install)
+
+2. Add link to sitemap to a view
+    
+    `<%= link_to 'Sitemap', '/sitemap' %>`
+
+The sitemaps are accessible at public_domain/sitemap.html, public_domain/sitemap.xml, and public_domain/sitemap.txt
+
+Hat tip [stephp][2] for doing all the heavy lifting with her [spree-sitemaps][3] extension.
+
+[1]: http://ext.spreecommerce.com/extensions/2-static-content
+[2]: http://github.com/stephp
+[3]: http://ext.spreecommerce.com/extensions/3-spree-sitemaps

data/Rakefile

@@ -0,0 +1,120 @@
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? SPREE_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["SPREE_ENV_FILE"]
+    require File.dirname(ENV["SPREE_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/SPREE/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(SPREE_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the SPREE_ROOT constant so specs will load the environment
+Object.send(:remove_const, :SPREE_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList["#{extension_root}/spec/**/*_spec.rb"]
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the sitemaps extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SpreeSitemapsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the sitemaps extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/app/controllers/sitemap_controller.rb

@@ -0,0 +1,99 @@
+class SitemapController < Spree::BaseController
+  def index
+    @public_dir = root_url
+    
+    @products = Product.active.find(:all)
+    @taxonomies = Taxonomy.all
+    
+    # Get Pages from static_content extension
+    @pages = _select_static_pages
+    
+    respond_to do |format|
+      format.html {  }
+      format.xml do
+        nav = _build_taxon_hash
+        nav = _build_pages_hash nav
+        nav = _add_products_to_tax nav, false
+        render :layout => false, :xml => _build_xml(nav, @public_dir)
+      end
+      format.text do
+        @nav = _add_products_to_tax(_build_taxon_hash, false)
+        render :layout => false
+      end
+    end
+  end
+
+  private
+  def _build_xml(nav, public_dir)
+    returning '' do |output|
+      xml = Builder::XmlMarkup.new(:target => output, :indent => 2) 
+      xml.instruct!  :xml, :version => "1.0", :encoding => "UTF-8"
+      xml.urlset( :xmlns => "http://www.sitemaps.org/schemas/sitemap/0.9" ) {
+        xml.url {
+          xml.loc public_dir
+          xml.lastmod Date.today
+          xml.changefreq 'daily'
+          xml.priority '1.0'
+        }
+        nav.each do |k, v| 
+          xml.url {
+            xml.loc public_dir + v['link']
+            xml.lastmod v['updated'].xmlschema			  #change timestamp of last modified
+            xml.changefreq 'weekly'
+            xml.priority '0.8'
+          } 
+        end
+      }
+    end
+  end
+
+  def _build_taxon_hash
+    nav = Hash.new
+    Taxon.find(:all).each do |taxon|
+      tinfo = Hash.new
+      tinfo['name'] = taxon.name
+      tinfo['depth'] = taxon.permalink.split('/').size
+      tinfo['link'] = 't/' + taxon.permalink 
+      tinfo['updated'] = taxon.updated_at
+      nav[taxon.permalink] = tinfo
+    end
+    nav
+  end
+
+  def _add_products_to_tax(nav, multiples_allowed)
+    Product.active.find(:all).each do |product|
+      pinfo = Hash.new
+      pinfo['name'] = product.name
+      pinfo['link'] = 'products/' + product.permalink	# primary
+      pinfo['updated'] = product.updated_at
+
+      nav[pinfo['link']] = pinfo				# store primary
+    end
+    nav
+  end
+  
+  def _build_pages_hash(nav)
+    return nav if @pages.empty?
+    
+    @pages.each do |page|
+      nav[page.slug] = {'name' => page.title,
+                        'link' => page.slug.gsub(/^\//, ''),
+                        'updated' => page.updated_at}
+    end
+    nav
+  end
+  
+  def _select_static_pages
+    pages = []
+    begin
+      slugs_to_reject = ["/on-main-page"]
+      Page.visible.each do |page|
+        pages << page unless slugs_to_reject.include?(page.slug)
+      end
+      
+    rescue NameError
+      pages = []
+    end
+    pages
+  end
+end

data/app/helpers/sitemap_helper.rb

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

data/app/views/sitemap/index.html.erb

@@ -0,0 +1,29 @@
+<h1>Sitemap</h1>
+<%= link_to Spree::Config[:site_name], @public_dir %><br />
+<% unless @pages.blank? %>
+  <ul>
+  <% @pages.each do |page| %>
+    <li><%= link_to page.title, @public_dir + page.slug %></li>
+  <% end %>
+  </ul>
+<% end %>
+<% unless @taxonomies.blank? %>  
+  <% @taxonomies.each do |taxonomy| %>
+    <% taxons = Taxon.find_all_by_taxonomy_id(taxonomy.id) %>
+    <h3><%= taxonomy.name %></h3>
+    <ul>
+    <% taxons.each do |taxon| %>
+      <% unless taxon.name == taxonomy.name %><li><%= link_to taxon.name, @public_dir + taxon.permalink %></li><% end %>
+    <% end %>
+    </ul>
+  <% end %>
+  
+<% end %>
+<% unless @products.blank? %>
+  <h3>Products</h3>
+  <ul>
+    <% @products.each do |product| %>
+      <li><%= link_to product.name, @public_dir + "products/" + product.permalink %></li>
+    <% end %>
+  </ul>
+<% end %>

data/app/views/sitemap/index.text.erb

@@ -0,0 +1,4 @@
+<%= @public_dir %>
+<% @nav.sort.each do |k,v| -%>
+<%= @public_dir %><%= v['link'] %>
+<% end -%>

data/config/routes.rb

@@ -0,0 +1,5 @@
+Rails.application.routes.draw do
+
+	resources :sitemap
+
+end

data/lib/dynamic_sitemaps.rb

@@ -0,0 +1,17 @@
+require 'spree_core'
+
+module DynamicSitemaps
+  class Engine < Rails::Engine
+   
+	 config.autoload_paths += %W(#{config.root}/lib)
+	  
+	def self.activate
+      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

data/lib/tasks/dynamic_sitemaps.rake

@@ -0,0 +1,10 @@
+namespace :db do
+  desc "Bootstrap your database for Spree."
+  task :bootstrap  => :environment do
+    # load initial database fixtures (in db/sample/*.yml) into the current environment's database
+    ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+    Dir.glob(File.join(DynamicSitemaps.root, "db", 'sample', '*.{yml,csv}')).each do |fixture_file|
+      Fixtures.create_fixtures("#{DynamicSitemaps.root}/db/sample", File.basename(fixture_file, '.*'))
+    end
+  end
+end

data/lib/tasks/install.rake

@@ -0,0 +1,26 @@
+namespace :dynamic_sitemaps do
+  desc "Copies all migrations and assets (NOTE: This will be obsolete with Rails 3.1)"
+  task :install do
+    Rake::Task['dynamic_sitemaps:install:migrations'].invoke
+    Rake::Task['dynamic_sitemaps:install:assets'].invoke
+  end
+
+  namespace :install do
+    desc "Copies all migrations (NOTE: This will be obsolete with Rails 3.1)"
+    task :migrations do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'db')
+      destination = File.join(Rails.root, 'db')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+
+    desc "Copies all assets (NOTE: This will be obsolete with Rails 3.1)"
+    task :assets do
+      source = File.join(File.dirname(__FILE__), '..', '..', 'public')
+      destination = File.join(Rails.root, 'public')
+      puts "INFO: Mirroring assets from #{source} to #{destination}"
+      Spree::FileUtilz.mirror_files(source, destination)
+    end
+  end
+
+end

data/spree_dynamic_sitemaps.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.platform    = Gem::Platform::RUBY
+  s.name        = 'spree_dynamic_sitemaps'
+  s.version     = '0.50.0'
+  s.summary     = 'Google sitemap for Spree stores'
+  #s.description = 'Add (optional) gem description here'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.author            = 'bzt'
+  # s.email             = ''
+  # s.homepage          = ''
+  # s.rubyforge_project = ''
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_path = 'lib'
+  s.requirements << 'none'
+
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: spree_dynamic_sitemaps
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 50
+  - 0
+  version: 0.50.0
+platform: ruby
+authors: 
+- bzt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-05-01 00:00:00 +04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- Rakefile
+- app/controllers/sitemap_controller.rb
+- app/helpers/sitemap_helper.rb
+- app/views/sitemap/index.html.erb
+- app/views/sitemap/index.text.erb
+- app/views/sitemap/index.xml.builder
+- config/routes.rb
+- lib/dynamic_sitemaps.rb
+- lib/tasks/dynamic_sitemaps.rake
+- lib/tasks/install.rake
+- spree_dynamic_sitemaps.gemspec
+has_rdoc: true
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Google sitemap for Spree stores
+test_files: []
+