sitemap_generator 4.3.1 → 5.0.0.beta

data/lib/sitemap_generator/sitemap_namer.rb

@@ -1,66 +1,6 @@
 module SitemapGenerator
-  # A class for generating sitemap names given the base for the filename.
-  # Deprecated.  Rather use the <tt>SitemapGenerator::SimpleNamer</tt> class and the
-  # +namer+ option on your sitemap object.
+  # A class for generating sitemap filenames.
   #
-  # === Example
-  # namer = SitemapNamer.new(:sitemap)
-  # namer.to_s => 'sitemap1.xml.gz'
-  # namer.next.to_s => 'sitemap2.xml.gz'
-  class SitemapNamer
-    NameError = Class.new(StandardError)
-
-    # Params:
-    #   base - string or symbol that forms the base of the generated filename
-    #
-    # Options include:
-    #   :extension - Default: '.xml.gz'. File extension to append.
-    #   :start     - Default: 1. Numerical index at which to start counting.
-    def initialize(base, options={});
-      @options = SitemapGenerator::Utilities.reverse_merge(options,
-        :extension => '.xml.gz',
-        :start => 1
-      )
-      @base = base
-      reset
-    end
-
-    def to_s
-      "#{@base}#{@count}#{@options[:extension]}"
-    end
-
-    # Increment count and return self
-    def next
-      @count += 1
-      self
-    end
-
-    # Decrement count and return self
-    def previous
-      raise NameError, "Already at the start of the series" if start?
-      @count -= 1
-      self
-    end
-
-    # Reset count to the starting index
-    def reset
-      @count = @options[:start]
-    end
-
-    def start?
-      @count <= @options[:start]
-    end
-  end
-
-  # A Namer for Sitemap Indexes.
-  # Deprecated.  Rather use the <tt>SitemapGenerator::SimpleNamer</tt> class and the
-  # +namer+ option on your sitemap object.
-  class SitemapIndexNamer < SitemapNamer
-    def to_s
-      "#{@base}#{@options[:extension]}"
-    end
-  end
-
   # The SimpleNamer uses the same namer instance for the sitemap index and the sitemaps.
   # If no index is needed, the first sitemap gets the first name.  However, if
   # an index is needed, the index gets the first name.
@@ -85,16 +25,20 @@ module SitemapGenerator
   #                the first name.  Thereafter, the numerical index defined by +start+
   #                is used, and subsequent names would be 'sitemap1.xml.gz', 'sitemap2.xml.gz', etc.
   #                In these examples the `base` string is assumed to be 'sitemap'.
-  class SimpleNamer < SitemapNamer
+  class SimpleNamer
     def initialize(base, options={})
-      super_options = SitemapGenerator::Utilities.reverse_merge(options,
-        :zero => nil # identifies the marker for the start of the series
+      @options = SitemapGenerator::Utilities.reverse_merge(options,
+        :zero => nil,  # identifies the marker for the start of the series
+        :extension => '.xml.gz',
+        :start => 1
       )
-      super(base, super_options)
+      @base = base
+      reset
     end
 
     def to_s
-      "#{@base}#{@count}#{@options[:extension]}"
+      extension = @options[:extension]
+      "#{@base}#{@count}#{extension}"
     end
 
     # Reset to the first name

data/spec/files/sitemap.groups.rb

@@ -14,15 +14,15 @@ SitemapGenerator::Sitemap.create(
     add '/three'
   end
 
-  # Test a deprecated namer
-  group(:sitemaps_namer => SitemapGenerator::SitemapNamer.new(:abc, :start => 3)) do
+  # Test a simple namer.
+  group(:namer => SitemapGenerator::SimpleNamer.new(:abc, :start => 4, :zero => 3)) do
     add '/four'
     add '/five'
     add '/six'
   end
 
   # Test a simple namer
-  group(:sitemaps_namer => SitemapGenerator::SimpleNamer.new(:def)) do
+  group(:namer => SitemapGenerator::SimpleNamer.new(:def)) do
     add '/four'
     add '/five'
     add '/six'

data/spec/sitemap_generator/builder/sitemap_file_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'SitemapGenerator::Builder::SitemapFile' do
-  let(:location) { SitemapGenerator::SitemapLocation.new(:namer => SitemapGenerator::SitemapNamer.new(:sitemap), :public_path => 'tmp/', :sitemaps_path => 'test/', :host => 'http://example.com/') }
+  let(:location) { SitemapGenerator::SitemapLocation.new(:namer => SitemapGenerator::SimpleNamer.new(:sitemap, :start => 2, :zero => 1), :public_path => 'tmp/', :sitemaps_path => 'test/', :host => 'http://example.com/') }
   let(:sitemap)  { SitemapGenerator::Builder::SitemapFile.new(location) }
 
   it "should have a default namer" do

data/spec/sitemap_generator/builder/sitemap_url_spec.rb

@@ -6,7 +6,7 @@ describe SitemapGenerator::Builder::SitemapUrl do
       :sitemaps_path => 'sitemaps/',
       :public_path => '/public',
       :host => 'http://test.com',
-      :namer => SitemapGenerator::SitemapNamer.new(:sitemap)
+      :namer => SitemapGenerator::SimpleNamer.new(:sitemap)
     )}
   let(:sitemap_file) { SitemapGenerator::Builder::SitemapFile.new(loc) }
 
@@ -19,7 +19,7 @@ describe SitemapGenerator::Builder::SitemapUrl do
 
   it "should build urls for sitemap files" do
     url = SitemapGenerator::Builder::SitemapUrl.new(sitemap_file)
-    url[:loc].should == 'http://test.com/sitemaps/sitemap1.xml.gz'
+    url[:loc].should == 'http://test.com/sitemaps/sitemap.xml.gz'
   end
 
   it "lastmod should default to the last modified date for sitemap files" do

data/spec/sitemap_generator/file_adaptor_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe "SitemapGenerator::FileAdapter" do
+  let(:location) { SitemapGenerator::SitemapLocation.new }
+  let(:adapter)  { SitemapGenerator::FileAdapter.new }
+
+  describe "write" do
+    it "should gzip contents if filename ends in .gz" do
+      adapter.expects(:gzip).once
+      location.stubs(:filename).returns('sitemap.xml.gz')
+      adapter.write(location, 'data')
+    end
+
+    it "should not gzip contents if filename does not end in .gz" do
+      adapter.expects(:plain).once
+      location.stubs(:filename).returns('sitemap.xml')
+      adapter.write(location, 'data')
+    end
+  end
+end

data/spec/sitemap_generator/link_set_spec.rb

@@ -41,7 +41,7 @@ describe SitemapGenerator::LinkSet do
       ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :include_root => true, :include_index => true)
       ls.include_root.should be_true
       ls.include_index.should be_true
-      ls.add_links { |sitemap| }
+      ls.create { |sitemap| }
       ls.sitemap.link_count.should == 2
     end
 
@@ -49,7 +49,7 @@ describe SitemapGenerator::LinkSet do
       ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :include_root => false)
       ls.include_root.should be_false
       ls.include_index.should be_false
-      ls.add_links { |sitemap| }
+      ls.create { |sitemap| }
       ls.sitemap.link_count.should == 0
     end
 
@@ -57,7 +57,7 @@ describe SitemapGenerator::LinkSet do
       ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :include_index => false)
       ls.include_root.should be_true
       ls.include_index.should be_false
-      ls.add_links { |sitemap| }
+      ls.create { |sitemap| }
       ls.sitemap.link_count.should == 1
     end
 
@@ -65,7 +65,7 @@ describe SitemapGenerator::LinkSet do
       ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :include_root => false, :include_index => false)
       ls.include_root.should be_false
       ls.include_index.should be_false
-      ls.add_links { |sitemap| }
+      ls.create { |sitemap| }
       ls.sitemap.link_count.should == 0
     end
   end
@@ -208,8 +208,8 @@ describe SitemapGenerator::LinkSet do
     let(:ls) { SitemapGenerator::LinkSet.new(:default_host => default_host, :verbose => true, :create_index => true) }
 
     it "should output summary lines" do
-      ls.sitemap.expects(:summary)
-      ls.sitemap_index.expects(:summary)
+      ls.sitemap.location.expects(:summary)
+      ls.sitemap_index.location.expects(:summary)
       ls.finalize!
     end
   end
@@ -365,22 +365,22 @@ describe SitemapGenerator::LinkSet do
         ls.group(:sitemaps_host => 'http://test.com') {}
       end
 
-      it "should use the same sitemaps_namer" do
+      it "should use the same namer" do
         @group = ls.group(:sitemaps_host => 'http://test.com') {}
         @group.sitemap.location.namer.should == ls.sitemap.location.namer
       end
     end
 
-    describe "sitemaps_namer" do
+    describe "namer" do
       it "should inherit the value" do
-        ls.group.sitemaps_namer.should == ls.sitemaps_namer
-        ls.group.sitemap.location.namer.should == ls.sitemaps_namer
+        ls.group.namer.should == ls.namer
+        ls.group.sitemap.location.namer.should == ls.namer
       end
 
       it "should set the value" do
-        namer = SitemapGenerator::SitemapNamer.new(:xxx)
-        group = ls.group(:sitemaps_namer => namer)
-        group.sitemaps_namer.should == namer
+        namer = SitemapGenerator::SimpleNamer.new(:xxx)
+        group = ls.group(:namer => namer)
+        group.namer.should == namer
         group.sitemap.location.namer.should == namer
         group.sitemap.location.filename.should =~ /xxx/
       end
@@ -412,7 +412,7 @@ describe SitemapGenerator::LinkSet do
         :filename => :xxx,
         :sitemaps_path => 'en/',
         :filename => :example,
-        :sitemaps_namer => SitemapGenerator::SitemapNamer.new(:sitemap)
+        :namer => SitemapGenerator::SimpleNamer.new(:sitemap)
       }.each do |key, value|
         it "if #{key} is present" do
           ls.group(key => value).sitemap.should_not == ls.sitemap
@@ -434,7 +434,8 @@ describe SitemapGenerator::LinkSet do
 
       {:sitemaps_path => 'en/',
         :filename => :example,
-        :sitemaps_namer => SitemapGenerator::SitemapNamer.new(:sitemap)}.each do |k, v|
+        :namer => SitemapGenerator::SimpleNamer.new(:sitemap)
+      }.each do |k, v|
 
         it "should not finalize the sitemap if #{k} is present" do
           ls.expects(:finalize_sitemap!).never
@@ -524,30 +525,30 @@ describe SitemapGenerator::LinkSet do
       ls.sitemap.location.host.should == host
     end
 
-    it "should set the sitemaps_namer" do
-      namer = SitemapGenerator::SitemapNamer.new(:xxx)
-      ls.create(:sitemaps_namer => namer)
-      ls.sitemaps_namer.should == namer
+    it "should set the namer" do
+      namer = SitemapGenerator::SimpleNamer.new(:xxx)
+      ls.create(:namer => namer)
+      ls.namer.should == namer
       ls.sitemap.location.namer.should == namer
       ls.sitemap.location.filename.should =~ /xxx/
     end
 
-    it "should support both sitemaps_namer and filename options" do
-      namer = SitemapGenerator::SitemapNamer.new("sitemap1_")
-      ls.create(:sitemaps_namer => namer, :filename => "sitemap1")
-      ls.sitemaps_namer.should == namer
+    it "should support both namer and filename options" do
+      namer = SitemapGenerator::SimpleNamer.new("sitemap2")
+      ls.create(:namer => namer, :filename => "sitemap1")
+      ls.namer.should == namer
       ls.sitemap.location.namer.should == namer
-      ls.sitemap.location.filename.should =~ /sitemap1_1/
-      ls.sitemap_index.location.filename.should =~ /^sitemap1/
+      ls.sitemap.location.filename.should =~ /^sitemap2/
+      ls.sitemap_index.location.filename.should =~ /^sitemap2/
     end
 
-    it "should support both sitemaps_namer and filename options no matter the order" do
-      namer = SitemapGenerator::SitemapNamer.new("sitemap1_")
-      options = {} #ActiveSupport::OrderedHash.new
-      options[:sitemaps_namer] = namer
-      options[:filename] = "sitemap1"
+    it "should support both namer and filename options no matter the order" do
+      options = {
+        :namer => SitemapGenerator::SimpleNamer.new('sitemap1'),
+        :filename => 'sitemap2'
+      }
       ls.create(options)
-      ls.sitemap.location.filename.should =~ /sitemap1_1/
+      ls.sitemap.location.filename.should =~ /^sitemap1/
       ls.sitemap_index.location.filename.should =~ /^sitemap1/
     end
 
@@ -574,13 +575,6 @@ describe SitemapGenerator::LinkSet do
       SitemapGenerator::Sitemap.create(:default_host => 'http://cnn.com')
       SitemapGenerator::Sitemap.instance_variable_set(:@added_default_links, false)
     end
-
-    it "should reset the deprecated sitemaps_namer, if set" do
-      ls.sitemaps_namer = stub(:reset => nil)
-      ls.sitemaps_namer.expects(:reset)
-      ls.send(:reset!)
-    end
-
   end
 
   describe "include_root?" do
@@ -668,26 +662,6 @@ describe SitemapGenerator::LinkSet do
     end
   end
 
-  describe "add_links" do
-    it "should not change the value of yield_sitemap" do
-      ls.stubs(:create)
-      ls.yield_sitemap = false
-      ls.add_links
-      ls.yield_sitemap.should be_false
-      ls.yield_sitemap = true
-      ls.add_links
-      ls.yield_sitemap.should be_true
-    end
-
-    it "should always yield the sitemap instance" do
-      ls.send(:interpreter).expects(:eval).with(:yield_sitemap => true).twice
-      ls.yield_sitemap = false
-      ls.add_links
-      ls.yield_sitemap = true
-      ls.add_links
-    end
-  end
-
   describe "add" do
     it "should not modify the options hash" do
       options = { :host => 'http://newhost.com' }
@@ -745,7 +719,7 @@ describe SitemapGenerator::LinkSet do
   end
 
   describe "create_index" do
-    let(:location) { SitemapGenerator::SitemapLocation.new(:namer => SitemapGenerator::SitemapNamer.new(:sitemap), :public_path => 'tmp/', :sitemaps_path => 'test/', :host => 'http://example.com/') }
+    let(:location) { SitemapGenerator::SitemapLocation.new(:namer => SitemapGenerator::SimpleNamer.new(:sitemap), :public_path => 'tmp/', :sitemaps_path => 'test/', :host => 'http://example.com/') }
     let(:sitemap)  { SitemapGenerator::Builder::SitemapFile.new(location) }
 
     describe "when false" do
@@ -851,4 +825,40 @@ describe SitemapGenerator::LinkSet do
       ls.send(:finalize_sitemap!)
     end
   end
+
+  describe "compress" do
+    it "should be true by default" do
+      ls.compress.should be_true
+    end
+
+    it "should be set on the location objects" do
+      ls.sitemap.location[:compress].should be_true
+      ls.sitemap_index.location[:compress].should be_true
+    end
+
+    it "should be settable and gettable" do
+      ls.compress = false
+      ls.compress.should be_false
+      ls.compress = :all_but_first
+      ls.compress.should == :all_but_first
+    end
+
+    it "should update the location objects when set" do
+      ls.compress = false
+      ls.sitemap.location[:compress].should be_false
+      ls.sitemap_index.location[:compress].should be_false
+    end
+
+    describe "in groups" do
+      it "should inherit the current compress setting" do
+        ls.compress = false
+        ls.group.compress.should be_false
+      end
+
+      it "should set the compress value" do
+        group = ls.group(:compress => false)
+        group.compress.should be_false
+      end
+    end
+  end
 end

data/spec/sitemap_generator/sitemap_generator_spec.rb

@@ -41,43 +41,6 @@ describe "SitemapGenerator" do
     end
   end
 
-  describe "generate sitemap with deprecated config" do
-    before :all do
-      SitemapGenerator::Sitemap.reset!
-      clean_sitemap_files_from_rails_app
-      copy_sitemap_file_to_rails_app(:deprecated)
-      with_max_links(10) { execute_sitemap_config }
-    end
-
-    it "should create sitemaps" do
-      file_should_exist(rails_path('public/sitemap_index.xml.gz'))
-      file_should_exist(rails_path('public/sitemap1.xml.gz'))
-      file_should_exist(rails_path('public/sitemap2.xml.gz'))
-      file_should_not_exist(rails_path('public/sitemap3.xml.gz'))
-    end
-
-    it "should have 13 links" do
-      SitemapGenerator::Sitemap.link_count.should == 13
-    end
-
-    it "index XML should validate" do
-      gzipped_xml_file_should_validate_against_schema rails_path('public/sitemap_index.xml.gz'), 'siteindex'
-    end
-
-    it "sitemap XML should validate" do
-      gzipped_xml_file_should_validate_against_schema rails_path('public/sitemap1.xml.gz'), 'sitemap'
-      gzipped_xml_file_should_validate_against_schema rails_path('public/sitemap2.xml.gz'), 'sitemap'
-    end
-
-    it "index XML should not have excess whitespace" do
-      gzipped_xml_file_should_have_minimal_whitespace rails_path('public/sitemap_index.xml.gz')
-    end
-
-    it "sitemap XML should not have excess whitespace" do
-      gzipped_xml_file_should_have_minimal_whitespace rails_path('public/sitemap1.xml.gz')
-    end
-  end
-
   describe "generate sitemap with normal config" do
     before :all do
       SitemapGenerator::Sitemap.reset!
@@ -493,6 +456,99 @@ describe "SitemapGenerator" do
     end
   end
 
+  describe "compress" do
+    let(:ls) { SitemapGenerator::LinkSet.new(:default_host => 'http://test.local', :include_root => false) }
+
+    before :each do
+      clean_sitemap_files_from_rails_app
+    end
+
+    describe "when false" do
+      before :each do
+        ls.compress = false
+      end
+
+      it "should not compress files" do
+        with_max_links(1) do
+          ls.create do
+            add('/one')
+            add('/two')
+            group(:filename => :group) {
+              add('/group1')
+              add('/group2')
+            }
+          end
+        end
+        file_should_exist(rails_path('public/sitemap.xml'))
+        file_should_exist(rails_path('public/sitemap1.xml'))
+        file_should_exist(rails_path('public/group.xml'))
+        file_should_exist(rails_path('public/group1.xml'))
+      end
+    end
+
+    describe "when :all_but_first" do
+      before :each do
+        ls.compress = :all_but_first
+      end
+
+      it "should not compress first file" do
+        with_max_links(1) do
+          ls.create do
+            add('/one')
+            add('/two')
+            add('/three')
+            group(:filename => :group) {
+              add('/group1')
+              add('/group2')
+            }
+            group(:filename => :group2, :compress => true) {
+              add('/group1')
+              add('/group2')
+            }
+            group(:filename => :group2, :compress => false) {
+              add('/group1')
+              add('/group2')
+            }
+          end
+        end
+        file_should_exist(rails_path('public/sitemap.xml'))
+        file_should_exist(rails_path('public/sitemap1.xml.gz'))
+        file_should_exist(rails_path('public/sitemap2.xml.gz'))
+        file_should_exist(rails_path('public/group.xml'))
+        file_should_exist(rails_path('public/group1.xml.gz'))
+        file_should_exist(rails_path('public/group2.xml.gz'))
+        file_should_exist(rails_path('public/group21.xml.gz'))
+      end
+    end
+
+    describe "in groups" do
+      it "should respect passed in compress option" do
+        with_max_links(1) do
+          ls.create do
+            group(:filename => :group1, :compress => :all_but_first) {
+              add('/group1')
+              add('/group2')
+            }
+            group(:filename => :group2, :compress => true) {
+              add('/group1')
+              add('/group2')
+            }
+            group(:filename => :group3, :compress => false) {
+              add('/group1')
+              add('/group2')
+            }
+          end
+        end
+        file_should_exist(rails_path('public/group1.xml'))
+        file_should_exist(rails_path('public/group11.xml.gz'))
+        file_should_exist(rails_path('public/group2.xml.gz'))
+        file_should_exist(rails_path('public/group21.xml.gz'))
+        file_should_exist(rails_path('public/group3.xml'))
+        file_should_exist(rails_path('public/group31.xml'))
+      end
+    end
+  end
+
   protected
 
   #