easy-sitemaps 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 varchar
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,17 @@
+= foo
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 varchar. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+require 'tasks/rails'
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "easy-sitemaps"
+    gem.summary = %Q{Easy Sitemaps for Rails}
+    gem.email = "charlesmbowman@gmail.com"
+    gem.homepage = "http://github.com/varchar/foo"
+    gem.authors = ["varchar", "robustdj"]
+    gem.add_development_dependency "rspec", ">= 1.2.0"
+    gem.add_development_dependency "roxml", ">= 3.0"
+    gem.add_development_dependency "action_view", ">= 2.3.2"    
+    gem.add_development_dependency "action_controller", ">= 2.3.2"        
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Sitemaps #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/init.rb

@@ -0,0 +1,2 @@
+ActiveRecord::Base.send :include, IP::Sitemap::ActiveRecord
+load 'tasks/sitemaps'

data/lib/ip/active_record.rb

@@ -0,0 +1,22 @@
+module IP
+  module Sitemap
+    module ActiveRecord
+ 
+      def self.included(base)
+        base.class_eval do
+          extend ClassMethods
+ 
+          class_inheritable_accessor :sitemap_options
+        end
+      end
+ 
+      module ClassMethods
+        def sitemap(options = {})
+          options.reverse_merge(:batch_size => 50000, 
+                                :route => "#{self.class.to_s.underscore}_url")
+          self.sitemap_options = options
+        end
+      end
+    end
+  end
+end

data/lib/ip/processor.rb

@@ -0,0 +1,104 @@
+require 'ruby-debug'
+require 'action_view'
+require 'action_controller'
+require 'zlib'
+
+module IP  
+  module Sitemap
+    
+    class RouteMaker
+      include Singleton
+      include ::ActionController::UrlWriter      
+      include ::ActionView::Helpers::TextHelper
+      include ::ActionView::Helpers::UrlHelper
+      include ::ActionView::Helpers::DateHelper
+      include ::ActionView::Helpers::TagHelper
+      include ::ActionView::Helpers::ActiveRecordHelper
+      
+      def set_host(host)
+        self.class.default_url_options[:host] = host
+      end       
+
+    end
+        
+    class Processor
+      
+      attr_accessor :urlsets, :output_directory, :host
+      
+      def initialize(output_directory, host)
+        self.urlsets = []
+        self.output_directory = output_directory
+        self.host = host
+      end
+    
+      def sitemap_classes
+        classes = ::ActiveRecord::Base.send(:subclasses).select{|klass| !klass.sitemap_options.nil? }
+      end
+    
+      def process
+        batch = 1
+        sitemap_classes.each do |klass|
+          klass.find_in_batches(:batch_size => klass.sitemap_options[:batch_size]).each do |group|
+            xml = process_group(klass, group)
+            filename = "/#{klass.to_s.underscore}_urlset_#{batch}.xml"
+            filename += '.gz' if klass.sitemap_options[:compress]
+            urlsets << filename
+            create_file(filename, xml, klass)
+            create_index_file
+            batch += 1            
+          end
+        end        
+      end
+      
+      def create_file(filename, xml, klass)
+        if klass.sitemap_options[:compress]
+          create_gz_file(filename, xml)
+        else
+          create_xml_file(filename, xml)
+        end
+      end
+            
+      def create_gz_file(filename, xml)
+        ::Zlib::GzipWriter.open(output_directory + filename) do |gz|
+          gz.write xml
+        end
+      end
+      
+      def create_xml_file(filename, xml)
+        File.open(output_directory + filename, "w") do |file|
+          file << xml
+        end
+      end
+      
+      def create_index_file
+        sitemap_index = IP::Sitemap::SitemapIndex.new
+        sitemap_index.sitemaps = []
+        urlsets.each do |urlset|
+          sitemap = IP::Sitemap::Sitemap.new
+          sitemap.loc = host + urlset
+          sitemap_index.sitemaps << sitemap
+        end
+        doc = ROXML::XML::Document.new
+        doc.root = sitemap_index.to_xml
+        doc.save(output_directory + '/sitemap_index.xml')
+      end
+      
+      def process_group(klass, group)
+        doc = ROXML::XML::Document.new
+        urlset = IP::Sitemap::Urlset.new
+        urlset.urls = []
+        group.each do |instance|
+          url = IP::Sitemap::Url.new
+          IP::Sitemap::RouteMaker.instance.set_host(host)
+          url.loc = IP::Sitemap::RouteMaker.instance.send(klass.sitemap_options[:route], instance)
+          url.lastmod = instance.updated_at.utc.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+          url.changefreq = klass.sitemap_options[:changefreq] || 'daily'
+          url.priority = klass.sitemap_options[:priority] || instance.try(:priority) || 1
+          urlset.urls << url
+        end
+        doc.root = urlset.to_xml
+        doc.to_s
+      end          
+    end
+  end
+end

data/lib/ip/urlset.rb

@@ -0,0 +1,36 @@
+require 'roxml'
+module IP
+  module Sitemap
+    
+    class Sitemap
+      include ROXML
+      xml_accessor :loc
+    end
+        
+    class Url
+      include ROXML
+      xml_accessor :loc
+      xml_accessor :lastmod, :as => Date
+      xml_accessor :changefreq
+      xml_accessor :priority, :as => Float
+    end
+
+    class Urlset
+      include ROXML
+      xml_name :urlset
+      xml_accessor :xmlns, :from => '@xmlns'
+      xml_accessor :urls, :as => [IP::Sitemap::Url]
+    
+      def xmlns
+        "http://www.sitemaps.org/schemas/sitemap/0.9"
+      end    
+    end
+    
+    class SitemapIndex
+      include ::ROXML
+      xml_name :sitemapindex
+      xml_accessor :sitemaps, :as => [IP::Sitemap::Sitemap]
+    end    
+  
+  end
+end

data/spec/ip/processor_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__)  + './../spec/resources/foo'
+require File.dirname(__FILE__) + './../lib/ip/urlset'
+require File.dirname(__FILE__) + './../lib/ip/processor'
+
+describe IP::Sitemap::Processor do
+  before(:each) do
+    fixture_path = File.dirname(__FILE__)  + './../spec/resources'
+    @xml = File.read(fixture_path + '/sitemap.xml')
+    @processor = IP::Sitemap::Processor.new(File.dirname(__FILE__)  + './../spec/resources/public','http://www.insiderpages.com')
+    @route_maker = IP::Sitemap::RouteMaker.instance
+    @route_maker.stub!(:test_route_url).and_return("foo")
+  end
+  
+  it "should have an output directory" do
+    @processor.output_directory.should == File.dirname(__FILE__)  + './../spec/resources/public'
+  end
+  
+  it "should return the urlset for the sitemap class" do
+    @processor.process_group(Foo, [Foo.new]).should == "<?xml version=\"1.0\"?>\n<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n  <url>\n    <loc>foo</loc>\n    <lastmod>0012-12-12T00:00:00+00:00</lastmod>\n    <changefreq>daily</changefreq>\n    <priority>2</priority>\n  </url>\n</urlset>\n"
+  end
+  
+  it "should generate a file for each batch of urlsets" do
+    @processor.stub!(:sitemap_classes).and_return([Foo])
+    @processor.process
+    @processor.urlsets.should == ["/foo_urlset_1.xml"]
+  end    
+  
+  it "should write the xml file" do
+    @processor.stub!(:sitemap_classes).and_return([Foo])
+    @processor.process
+    File.exists?(File.dirname(__FILE__)  + './../spec/resources/public' + @processor.urlsets.first).should == true      
+  end
+  
+  it "should generate the sitemap_index file" do
+    @processor.stub!(:sitemap_classes).and_return([Foo])
+    @processor.process
+    File.exists?(File.dirname(__FILE__)  + './../spec/resources/public' + '/sitemap_index.xml').should == true
+    xml = File.read(File.dirname(__FILE__)  + './../spec/resources/public' + '/sitemap_index.xml')
+    IP::Sitemap::SitemapIndex.from_xml(xml).sitemaps.first.loc.should == "http://www.insiderpages.com/foo_urlset_1.xml"
+  end
+  
+  it "should gzip the urlsets" do
+    Foo.sitemap_options[:compress] = true
+    @processor.stub!(:sitemap_classes).and_return([Foo])
+    @processor.process
+    File.exists?(File.dirname(__FILE__)  + './../spec/resources/public' + '/foo_urlset_1.xml.gz').should == true    
+  end
+end

data/spec/ip/urlset_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + './../lib/ip/urlset'
+
+describe IP::Sitemap::Urlset do
+  before(:each) do
+    fixture_path = File.dirname(__FILE__)  + './../spec/resources'
+    @xml = File.read(fixture_path + '/sitemap.xml')
+  end
+  
+  it "#from_xml should parse the sitemap.xml file" do
+    urlset = IP::Sitemap::Urlset.from_xml(@xml)
+    url = urlset.urls.first
+    url.loc.should == 'http://www.example.com/'
+    url.lastmod.to_s.should == '2005-01-01'
+    url.changefreq.should == 'monthly'
+    url.priority.should == 0.8
+  end
+  
+  it "#to_xml should create xml" do
+    urlset = IP::Sitemap::Urlset.new
+    url = IP::Sitemap::Url.new
+    url.loc = 'http://www.example.com/'
+    url.lastmod = Date.new(2005,1,1)
+    url.changefreq = 'monthly'
+    url.priority = 0.8    
+    urlset.urls = [url]
+    urlset.to_xml.to_s.should == "<urlset xmlns=\"http://www.sitemaps.org/schemas/sitemap/0.9\">\n  <url>\n    <loc>http://www.example.com/</loc>\n    <lastmod>2005-01-01</lastmod>\n    <changefreq>monthly</changefreq>\n    <priority>0.8</priority>\n  </url>\n</urlset>"
+  end
+end

data/spec/resources/foo.rb

@@ -0,0 +1,15 @@
+class Foo
+  
+  def self.sitemap_options
+    {:batch_size => 50000, :route => :test_route_url, :priority => 2}
+  end
+  
+  def self.find_in_batches(options = {})
+    [[Foo.new]]
+  end
+  
+  def updated_at
+    DateTime.new(12,12,12) # Mon, 12 Dec 0012 00:00:00 +0000
+  end
+  
+end

data/spec/resources/public/foo_urlset_1.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+  <url>
+    <loc>foo</loc>
+    <lastmod>0012-12-12T00:00:00+00:00</lastmod>
+    <changefreq>daily</changefreq>
+    <priority>2</priority>
+  </url>
+</urlset>

data/spec/resources/public/sitemap_index.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<sitemapindex>
+  <sitemap>
+    <loc>http://www.insiderpages.com/foo_urlset_1.xml</loc>
+  </sitemap>
+</sitemapindex>

data/spec/resources/sitemap.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+   <url>
+      <loc>http://www.example.com/</loc>
+      <lastmod>2005-01-01</lastmod>
+      <changefreq>monthly</changefreq>
+      <priority>0.8</priority>
+   </url>
+</urlset>

data/tasks/rails.rb

@@ -0,0 +1,2 @@
+# $VERBOSE = nil
+# Dir["#{Gem.searcher.find('sitemaps').full_gem_path}/tasks/*.rake"].each { |ext| load ext }

data/tasks/sitemaps.rake

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__), '/../lib/ip/processor')
+
+namespace :sitemap do
+
+  desc "Generates the sitemap"
+  task :generate do    
+    require(File.join(RAILS_ROOT, 'config', 'environment'))
+    output_directory = ENV['OUTPUT_DIRECTORY'] || RAILS_ROOT + '/public'
+    host = ENV['HOST']
+    processor = IP::Sitemap::Processor.new(output_directory, host)
+    processor.process
+  end
+
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: easy-sitemaps
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- varchar
+- robustdj
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-01 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: roxml
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: action_view
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: action_controller
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: 
+email: charlesmbowman@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/ip/active_record.rb
+- lib/ip/processor.rb
+- lib/ip/urlset.rb
+- pkg/sitemaps-0.0.1.gem
+- spec/ip/processor_spec.rb
+- spec/ip/urlset_spec.rb
+- spec/resources/foo.rb
+- spec/resources/public/foo_urlset_1.xml
+- spec/resources/public/foo_urlset_1.xml.gz
+- spec/resources/public/sitemap_index.xml
+- spec/resources/sitemap.xml
+- tasks/rails.rb
+- tasks/sitemaps.rake
+has_rdoc: true
+homepage: http://github.com/varchar/foo
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Easy Sitemaps for Rails
+test_files: 
+- spec/ip/processor_spec.rb
+- spec/ip/urlset_spec.rb
+- spec/resources/foo.rb