ar_sitemapper 1.0.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MmU4N2FhNWNmNjgxOWY5NzlkNmU2YTdkOGIxYTQ5N2U3MGRiYTk1Zg==
+  data.tar.gz: !binary |-
+    MTUzMzE5OWU3YWRmZTI3YzBlY2I0OTE1YzkyMzU0MDA4OWIzYjI3ZQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NWU3Y2ZiOTE4Njg5NDA5NGUxN2IyODliYzg0ZWRlZTZkYTY4NmZkMDBiN2Ey
+    ZjhiNGU0YWQwOTM5ZjAxZTkyNTE0ODdiYWUxNjQwMThmMWNkOTgxZWY0NzY1
+    YTFkNzBhZjQwNmU5YjNhN2JiM2NiNGE2OTRjZmUyYjNhZDVkMWY=
+  data.tar.gz: !binary |-
+    N2NkMWQ2OWM3ZmFhMDY5MjhmNjkyNGQ3NzM1MWE0MWI4MWY3OThiYWZiZGQw
+    NmRiNzFmMWYzZGVkZDkxYmRiNDJjYzY2MjY0MDdhY2NlZTdkMWU2NzVhMzE4
+    ZDZjMWI1ODhkY2UyNmE1MjMwNzYyNmJjN2I5ZjE2MDQwZjk5YzY=

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+nbproject
+
+*~
+*.swp
+
+test/dummy/.sass-cache
+test/dummy/log/*.log
+test/dummy/db/*.sqlite3

data/.ruby-gemset

@@ -0,0 +1 @@
+ar_sitemapper

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Changelog.rdoc

@@ -0,0 +1,28 @@
+== CHANGELOG
+
+=== v1.0.0 // 2013-09-28
+* Transformed into a gem (just for sport)
+* Removed Rails 2'ism
+* Splits sitemaps with over 50,000 entries
+* Rails integration as engine
+* Removed hardcoded sitemaps.yml configuration
+
+=== v0.5 // 2010-10-25
+* supports conditions and named scopes for build_sitemap via YML file
+* documentation and samples
+
+=== v0.4 // 2010-09-24
+* supports Proc code in sitemap yaml for dynamic url generation based on model iteration
+* additional files can now be added to the sitemap index file.
+* last-modified for models' sitemaps within the sitemap index file is now based on :created_at when a corresponding column is found
+* added barebone fake app for running tests
+
+=== v0.3 // 2010-09-22
+* classes restructured
+
+=== v0.3 // 2010-07-20
+* added Map class
+* filename will be auto-derived by modelname by default now
+
+=== v0.1 // 2010-07-16
+* Initial version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ar_sitemapper.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,98 @@
+PATH
+  remote: .
+  specs:
+    ar_sitemapper (1.0.0)
+      activesupport (>= 3.0, < 4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    builder (3.0.4)
+    erubis (2.7.0)
+    hike (1.2.3)
+    i18n (0.6.5)
+    journey (1.0.4)
+    json (1.8.0)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    metaclass (0.0.1)
+    mime-types (1.25)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.8.0)
+    polyglot (0.3.3)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.14)
+      actionmailer (= 3.2.14)
+      actionpack (= 3.2.14)
+      activerecord (= 3.2.14)
+      activeresource (= 3.2.14)
+      activesupport (= 3.2.14)
+      bundler (~> 1.0)
+      railties (= 3.2.14)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.1.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.8)
+    thor (0.18.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.37)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ar_sitemapper!
+  mocha
+  rails (>= 3.0, < 4.0)
+  sqlite3

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2010, Carsten Zimmermann
+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, 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 and/or other materials provided with the distribution.
+    * Neither the name of the original author / copyright holder 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 LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, 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.

data/README.rdoc

@@ -0,0 +1,176 @@
+== ActiveRecord Sitemapper
+=== Low-level sitemap-building
+
+The standard approach to generate XML sitemaps for a Ruby on Rails application
+seems to be creating a special SitemapsController with xml views and a bit
+of routes.rb magic.
+
+I used to generate sitemaps created thus via a nightly rake task to have them
+cached and delivered statically by Apache. That felt wrong, I wanted a more
+"low-level" approach. Actually, as low-level as possible and I ended up at
+ActiveRecord::Base: this plugin enhances your ActiveRecord model to export 
+its data to a sitemap in an intuitive way.
+
+Also yes, I know there are probably a gazillion projects covering this already.
+
+== Installation
+
+To add *ar_sitemapper* to your Rails 3 project, add it to your Gemfile:
+
+  gem 'ar_sitemapper', '~> 1.0.0'
+
+== Usage
+
+=== ActiveRecord drop-in
+
+You can use +build_sitemap+ directly on any ActiveRecord model. The following
+example will create a sitemap of all your Content objects as Rails.root/public/sitemap_contents.xml.gz:
+
+  Content.build_sitemap :all do |content, xml|
+    xml.loc content_url(content)
+    xml.changefreq 'weekly'
+    xml.lastmod content.updated_at.strftime("%Y-%m-%d")
+    xml.priority 0.5
+  end
+
+You can pass ActiveRecord::Base.find options as arguments to +build_sitemap+
+to fine-tune the selection of objects you want to extract:
+
+  Post.build_sitemap :all, :conditions => ["published IS TRUE"], :order => :name do |post, xml|
+    # do stuff here
+  end
+
+*Note*: if you want to use your named route helpers in the block, be sure to have
+ActionController::UrlWriter included. Setting default_url_options[:host]
+is helpful, too.
+
+=== Output
+
+*ar_sitemapper* will derive its sitemap filename from the model's name and will
+default to Gzip compressed output. If can write to +stdout+ as well if +file+
+is explicitely set to +nil+ or +false+.
+
+It will automatically compress your XML sitemap with Gzip if the
+filename parameter suggests it (ie. ends with ".gz"). Alternatively, you can
+enforce or disable Gzip compression by passing true or false to the +gzip+ option.
+
+Both of the following examples will create a gzip'ed file named "test.xml.gz":
+
+  Content.build_sitemap :all, :file => "test.xml.gz" { |content, xml| ... }
+  Content.build_sitemap :all, :file => "test.xml", :gzip => true { |content, xml| ... }
+
+=== Sitemaps for static data
+
+Sitemap creation is done via a block, so you can do whatever you want in it.
+For added flexibility, you can use *ar_sitemapper* with arbitrary data
+collections (ie. generating sitemaps for static content). Future versions will
+support YAML configuration of such static content.
+
+  sites = [
+    { :url => "http://example.com/your/static/content1.html", :freq => "always",  :prio => "1.0" },
+    { :url => "http://example.com/your/static/content2.html", :freq => "monthly", :prio => "0.3" },
+  ]
+
+  AegisNet::Sitemapper::Generator.create(sites) do |site, xml|
+    xml.loc site[:url]
+    xml.changefreq site[:freq]
+    xml.priority site[:prio]
+  end
+
+=== YAML configuration
+Sitemapper supports configuration via a YAML file which is expected to reside in
+<tt>Rails.root/config/sitemaps.yml</tt>.
+
+==== Supported top level configuration options
+* +default_host+: base hostname used for url generation (mandatory).
+* +local_path+: where to store the generated sitemaps on the local system (mandatory).
+* +ping+: boolean whether or not to ping search engines on successful sitemap generation.
+* +index+: options for the main sitemap index file, ie. the file that references all others.
+* +static+: options for the sitemap that lists URLs to static content (ie. URLs not
+  necessarily related to AR models)
+* +models+: options for model-related URLset sitemaps
+* +ping+: a list of search engines' ping services.
+
+==== The <tt>index</tt> option
+* +sitemapfile+: the name of the the generated sitemap.
+* +includes+: an array of sitemaps that should be included in the sitemap index but
+  are _not_ generated directly through AR:Sitemapper (eg. a KML-sitemap).
+
+==== The <tt>static</tt> option
+* +sitemapfile+: the name of the the generated sitemap.
+* +urlset+: a list of static pages to include into the sitemap. Every item must
+  have a +loc+ element. A +changefreq+ and +priority+ element is optional and
+  defaults to _weekly_ and <i>0.5</i>, respectively.
+
+==== The <tt>model</tt> option
+A list of models to create sitemaps for. The key must be the downcased und
+underscored name of the model. Supported / required options for every model-based
+sitemap are:
+* +sitemapfile+: the name of the the generated sitemap (mandatory).
+* +loc+: a Proc definition to generate the URLs for each object with (mandatory).
+* +changefreq+: optional, defaults to 'weekly'
+* +priority+: optional, defaults to '0.5'
+* +lastmod+: you can use ERB to insert the date you desire.
+* +conditions+: conditions to be merged into the finder of +build_sitemap+ (optional).
+* +scope+: a named scope to find objects with
+
+==== Sample YAML file
+
+  default_host: "www.example.com"
+  local_path: <%= File.join Rails.root, "public", "sitemaps" %>
+  ping: true
+  index:
+    sitemapfile: "sitemap_index.xml"
+    includes:
+      -
+        loc: some_other_sitemap.xml
+  static:
+    sitemapfile: "sitemap_static.xml.gz"
+    urlset:
+      -
+        loc: "http://www.example.com/static/content"
+        changefreq: weekly
+        priority: 1.0
+      -
+        loc: "http://www.example.com/another/page"
+        changefreq: weekly
+        priority: 1.0
+  models:
+    foo_bar:
+      sitemapfile: sitemap_foo_bars.xml.gz
+      lastmod: <%= 2.days.ago %>
+      loc: Proc.new {|object| foo_bar_path(object) }
+      changefreq: weekly
+      priority: 0.7
+      conditions: "foo > 1"
+    acme:
+      sitemapfile: sitemap_proctests.xml.gz
+      scope: liquid
+      lastmod: <%= Acme.find(:last, :order => :updated_at).updated_at %>
+      loc: Proc.new {|object| acme_path(object) }
+      changefreq: weekly
+      priority: 0.8
+  pings:
+    - http://submissions.ask.com/ping?sitemap=
+    - http://www.google.com/webmasters/sitemaps/ping?sitemap=
+    - http://search.yahooapis.com/SiteExplorerService/V1/updateNotification?appid=YahooDemo&url=
+    - http://www.bing.com/webmaster/ping.aspx?siteMap=
+
+
+=== Rake task
+The gem provides a rake task to rebuild all sitemaps from its config file:
+
+  rake sitemapper:rebuild
+
+
+== .plan
+* support KML files
+* allow for a custom iterator supplied as Proc for Generator::create (ie. to make use of ARs batch finding)
+* cleanup
+* more flexible syntax for conditions in yml file
+* guess RESTful object path and make Proc object for loc in models optional
+* Install a sample sitemap.yml file
+
+---
+
+Copyright (c) 2010-2013 Carsten Zimmermann, released under a BSD-type license

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rdoc/task'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the ar_sitemapper plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the ar_sitemapper plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ActiveRecord Sitemapper'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/ar_sitemapper.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require "sitemapper/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar_sitemapper"
+  spec.version       = AegisNet::Sitemapper::VERSION
+  spec.authors       = ["Carsten Zimmermann"]
+  spec.email         = ["cz@aegisnet.de"]
+  spec.description   = %q{Faciliates generating static sitemap XML files from ActiveRecord}
+  spec.summary       = %q{Faciliates generating static sitemap XML files from ActiveRecord}
+  spec.homepage      = ""
+  spec.license       = "BSD 3-Clause"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 3.0', '< 4.0'
+
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'mocha'
+  spec.add_development_dependency 'rails', '>= 3.0', '< 4.0'
+end

data/install.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'config/environment'
+FileUtils.cp File.join(File.dirname(__FILE__), "templates", "sitemapper.rake"), File.join(Rails.root, "tasks")
+FileUtils.cp File.join(File.dirname(__FILE__), "templates", "sitemaps.yml"), File.join(Rails.root, "config")

data/lib/ar_sitemapper.rb

@@ -0,0 +1,11 @@
+require 'sitemapper/engine'
+
+module AegisNet
+  module Sitemapper
+    mattr_accessor :configuration, :sitemap_file
+
+    def self.configure
+      yield self if block_given?
+    end
+  end
+end

data/lib/sitemapper/active_record/builder.rb

@@ -0,0 +1,54 @@
+require 'sitemapper/loader'
+
+module AegisNet
+  module Sitemapper
+    module ActiveRecord
+      module Builder
+        def self.included(base)
+          base.extend SingletonMethods
+        end
+
+        module SingletonMethods
+          # Adds sitemap building functionality to ActiveRecord models.
+          #
+          # The option +:filename+ is derived from the model name and will be set to
+          # Rails.root/public/sitemap_modelnames.xml.gz by default. Set +:filename+
+          # to +nil+ or +false+ explicitely if you don't want the filename to be
+          # guessed (ie. if you want output to stdout).
+          #
+          # === Parameters
+          # * +scope+: :all, :first, :last or a named scope
+          # * +options+: a Hash with options to pass to ActiveRecord::Base.find and AegisNet::Sitemapper::Generator
+          #
+          # === Supported Options
+          # * see AegisNet::Sitemapper::Generator::VALID_GENERATOR_OPTIONS
+          #
+          # === Example
+          #  Content.build_sitemap :all, :file => "sitemap_content.xml" do |content, xml|
+          #    xml.loc content_path(content)
+          #    xml.changefreq "weekly"
+          #    xml.priority 0.5
+          #  end
+          #
+          def build_sitemap scope, options = {}
+            scope = scope.to_sym
+            raise(ArgumentError, "Unknown ActiveRecord finder: #{scope}") unless self.respond_to?(scope)
+            valid_find_options = [ :conditions, :include, :joins, :limit, :offset,
+                                   :order, :select, :group, :having, :from ]
+            options = options.symbolize_keys!
+            options.assert_valid_keys(Generator::VALID_GENERATOR_OPTIONS, valid_find_options)
+
+            find_options = options.select{|option, value| valid_find_options.include?(option) }
+            sitemap_opts = options.delete_if{|k, v| find_options.keys.include?(k)}
+
+            # Extra treatment for the filename option
+            sitemap_opts[:file] = sitemap_opts.keys.include?(:file) ? sitemap_opts[:file] : AegisNet::Sitemapper::Generator.default_filename(self.class)
+
+            entries = self.send(scope, find_options).to_a # get an array for :first and :last, too
+            AegisNet::Sitemapper::Generator.create(entries, sitemap_opts) { |entry, xml|  yield entry, xml }
+          end
+        end
+      end
+    end
+  end
+end