sitemap_generator 3.0.0 → 3.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ./
   specs:
-    sitemap_generator (3.0.0)
+    sitemap_generator (3.1.0)
       builder
 
 GEM

data/README.md

@@ -36,6 +36,7 @@ Create `sitemap.rb`:
       add '/home', :changefreq => 'daily', :priority => 0.9
       add '/contact_us', :changefreq => 'weekly'
     end
+    SitemapGenerator::Sitemap.ping_search_engines # called for you when you use the rake task
 
 Run it:
 
@@ -48,6 +49,11 @@ Output:
     + sitemap_index.xml.gz                                  1 sitemaps /  228 Bytes
     Sitemap stats: 4 links / 1 sitemaps / 0m00s
 
+    Successful ping of Google
+    Successful ping of Ask
+    Successful ping of Bing
+    Successful ping of Sitemap Writer
+
 Contribute
 -------
 
@@ -58,6 +64,7 @@ Does your website use SitemapGenerator to generate Sitemaps?  Where would you be
 Changelog
 -------
 
+- v3.1.0: Add `add_to_index` method to add links to the sitemap index.  Add `sitemap` method for accessing the LinkSet instance from within `create()`.  Don't modify options hashes passed to methods.  Fix and improve `yield_sitemap` option handling.
 - **v3.0.0: Framework agnostic**; fix alignment in output, show directory sitemaps are being generated into, only show sitemap compressed file size; toggle output using VERBOSE environment variable; remove tasks/ directory because it's deprecated in Rails 2;  Simplify dependencies.
 - v2.2.1: Support adding new search engines to ping and modifying the default search engines.
           Allow the URL of the sitemap index to be passed as an argument to `ping_search_engines`.  See **Pinging Search Engines**.
@@ -450,7 +457,7 @@ You can read more about `add` in the [XML Specification](http://sitemaps.org/pro
 
   Host to use when building the URL.  Example:
 
-        add '/login', :host => 'https://securehost.com/login'
+        add '/login', :host => 'https://securehost.com'
 
 * `priority` - Default: `0.5` (Float).
 
@@ -458,6 +465,55 @@ You can read more about `add` in the [XML Specification](http://sitemaps.org/pro
 
         add '/about', :priority => 0.75
 
+Adding Links to the Sitemap Index
+----------
+
+Sometimes you may need to manually add some links to the sitemap index file.  For example if you are generating your sitemaps incrementally you may want to create a sitemap index which includes the files which have already been generated.  To achieve this you can use the `add_to_index` method which works exactly the same as the `add` method described above.
+
+It supports the same options as `add`, namely:
+
+* `changefreq`
+* `lastmod`
+* `host`
+
+  The value for `host` defaults to whatever you have set as your `sitemaps_host`.  Remember that the `sitemaps_host` is the host where your sitemaps reside.  If your sitemaps are on the same host as your `default_host`, then the value for `default_host` is used.  Example:
+
+        add_to_index '/mysitemap1.xml.gz', :host => 'http://sitemaphostingserver.com'
+
+* `priority`
+
+An example:
+
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+    SitemapGenerator::Sitemap.create do
+      add_to_index '/mysitemap1.xml.gz'
+      add_to_index '/mysitemap2.xml.gz'
+      ...
+    end
+
+Accessing the LinkSet instance
+----------
+
+Sometimes you need to mess with the internals to do custom stuff.  If you need access to the LinkSet instance from within `create()` you can use the `sitemap` method to do so.
+
+In this example, say we have already pre-generated three sitemap files: `sitemap1.xml.gz`, `sitemap2.xml.gz`, `sitemap3.xml.gz`.  Now we want to start the sitemap generation at `sitemap4.xml.gz` and create a bunch of new sitemaps.  There are a few ways we can do this, but this is an easy way:
+
+    SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+    SitemapGenerator::Sitemap.create do
+      3.times do |i|
+        add_to_index sitemap.sitemaps_namer.to_s
+        sitemap.sitemaps_namer.next
+      end
+      add '/home'
+      add '/another'
+    end
+
+The output looks something like this:
+
+    In /Users/karl/projects/sitemap_generator-test/public/
+    + sitemap4.xml.gz                                          4 links /  347 Bytes
+    + sitemap_index.xml.gz                                  4 sitemaps /  242 Bytes
+    Sitemap stats: 4 links / 4 sitemaps / 0m00s
 
 Speeding Things Up
 ----------

data/VERSION

@@ -1 +1 @@
-3.0.0
+3.1.0

data/lib/sitemap_generator.rb

@@ -61,7 +61,7 @@ module SitemapGenerator
 
   # Returns true if we should yield the sitemap instance to the block, false otherwise.
   def self.yield_sitemap?
-    !!@yeild_sitemap
+    !!@yield_sitemap
   end
 
   self.root      = File.expand_path(File.join(File.dirname(__FILE__), '../'))  # Root of the install dir, not the Rails app

data/lib/sitemap_generator/builder/sitemap_index_url.rb

@@ -6,7 +6,7 @@ module SitemapGenerator
 
       def initialize(path, options={})
         if index = path.is_a?(SitemapGenerator::Builder::SitemapIndexFile) && path
-          SitemapGenerator::Utilities.reverse_merge!(options, :host => index.location.host, :lastmod => Time.now, :changefreq => 'always', :priority => 1.0)
+          options = SitemapGenerator::Utilities.reverse_merge(options, :host => index.location.host, :lastmod => Time.now, :changefreq => 'always', :priority => 1.0)
           path = index.location.path_in_public
           super(path, options)
         else

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -27,6 +27,7 @@ module SitemapGenerator
       # * +geo+
       # * +news+
       def initialize(path, options={})
+        options = options.dup
         if sitemap = path.is_a?(SitemapGenerator::Builder::SitemapFile) && path
           SitemapGenerator::Utilities.reverse_merge!(options, :host => sitemap.location.host, :lastmod => sitemap.lastmod)
           path = sitemap.location.path_in_public

data/lib/sitemap_generator/interpreter.rb

@@ -21,7 +21,7 @@ module SitemapGenerator
     #
     # All other options are passed to the LinkSet by setting them using accessor methods.
     def initialize(opts={}, &block)
-      SitemapGenerator::Utilities.reverse_merge!(opts, :link_set => SitemapGenerator::Sitemap)
+      opts = SitemapGenerator::Utilities.reverse_merge(opts, :link_set => SitemapGenerator::Sitemap)
       @linkset = opts.delete :link_set
       @linkset.send(:set_options, opts)
       eval(&block) if block_given?
@@ -31,6 +31,10 @@ module SitemapGenerator
       @linkset.add(*args)
     end
 
+    def add_to_index(*args)
+      @linkset.add_to_index(*args)
+    end
+    
     # Start a new group of sitemaps.  Any of the options to SitemapGenerator.new may
     # be passed.  Pass a block with calls to +add+ to add links to the sitemaps.
     #
@@ -39,12 +43,18 @@ module SitemapGenerator
       @linkset.group(*args, &block)
     end
 
+    # Return the LinkSet instance so that you can access it from within the `create` block
+    # without having to use the yield_sitemap option.
+    def sitemap
+      @linkset
+    end
+
     # Evaluate the block in the interpreter.  Pass :yield_sitemap => true to
     # yield the Interpreter instance to the block...for old-style calling.
     def eval(opts={}, &block)
       if block_given?
         if opts[:yield_sitemap]
-          yield self
+          yield @linkset
         else
           instance_eval(&block)
         end
@@ -59,6 +69,7 @@ module SitemapGenerator
     #   Default is config/sitemap.rb in your application's root directory.
     # All other options are passed to +new+.
     def self.run(opts={}, &block)
+      opts = opts.dup
       config_file = opts.delete(:config_file)
       config_file ||= SitemapGenerator.app.root + 'config/sitemap.rb'
       interpreter = self.new(opts)

data/lib/sitemap_generator/link_set.rb

@@ -8,7 +8,7 @@ module SitemapGenerator
     @@new_location_opts = [:filename, :sitemaps_path, :sitemaps_namer]
 
     attr_reader :default_host, :sitemaps_path, :filename
-    attr_accessor :verbose, :yahoo_app_id, :include_root, :include_index, :sitemaps_host, :adapter
+    attr_accessor :verbose, :yahoo_app_id, :include_root, :include_index, :sitemaps_host, :adapter, :yield_sitemap
 
     # Create a new sitemap index and sitemap files.  Pass a block calls to the following
     # methods:
@@ -36,7 +36,7 @@ module SitemapGenerator
         start_time = Time.now
         puts "In #{sitemap_index.location.public_path}"
       end
-      interpreter.eval(:yield_sitemap => @yield_sitemap || SitemapGenerator.yield_sitemap?, &block)
+      interpreter.eval(:yield_sitemap => yield_sitemap?, &block)
       finalize!
       end_time = Time.now if verbose
       output(sitemap_index.stats_summary(:time_taken => end_time - start_time)) if verbose
@@ -45,9 +45,10 @@ module SitemapGenerator
 
     # Dreprecated.  Use create.
     def add_links(&block)
+      original_value = @yield_sitemap
       @yield_sitemap = true
       create(&block)
-      @yield_sitemap = false
+      @yield_sitemap = original_value
     end
 
     # Constructor
@@ -99,7 +100,7 @@ module SitemapGenerator
     # * <tt>:verbose</tt> - If +true+, output a summary line for each sitemap and sitemap
     #   index that is created.  Default is +false+.
     def initialize(options={})
-      SitemapGenerator::Utilities.reverse_merge!(options,
+      options = SitemapGenerator::Utilities.reverse_merge(options,
         :include_root => true,
         :include_index => true,
         :filename => :sitemap,
@@ -127,7 +128,7 @@ module SitemapGenerator
     #   host - host for the link, defaults to your <tt>default_host</tt>.
     def add(link, options={})
       add_default_links if !@added_default_links
-      sitemap.add(link, SitemapGenerator::Utilities.reverse_merge!(options, :host => @default_host))
+      sitemap.add(link, SitemapGenerator::Utilities.reverse_merge(options, :host => @default_host))
     rescue SitemapGenerator::SitemapFullError
       finalize_sitemap!
       retry
@@ -136,6 +137,16 @@ module SitemapGenerator
       retry
     end
 
+    # Add a link to the Sitemap Index.
+    # * link - A string link e.g. '/sitemaps/sitemap1.xml.gz' or a SitemapFile instance.
+    # * options - A hash of options including `:lastmod`, ':priority`, ':changefreq` and `:host`
+    #
+    # The `:host` option defaults to the value of `sitemaps_host` which is the host where your
+    # sitemaps reside.  If no `sitemaps_host` is set, the `default_host` is used.
+    def add_to_index(link, options={})
+      sitemap_index.add(link, SitemapGenerator::Utilities.reverse_merge(options, :host => sitemaps_host))
+    end
+
     # Create a new group of sitemap files.
     #
     # Returns a new LinkSet instance with the options passed in set on it.  All groups
@@ -310,6 +321,11 @@ module SitemapGenerator
       @verbose
     end
 
+    # Return a boolean indicating whether or not to yield the sitemap.
+    def yield_sitemap?
+      @yield_sitemap.nil? ? SitemapGenerator.yield_sitemap? : !!@yield_sitemap
+    end
+
     protected
 
     # Set each option on this instance using accessor methods.  This will affect
@@ -318,6 +334,7 @@ module SitemapGenerator
     # If both `filename` and `sitemaps_namer` are passed, set filename first so it
     # doesn't override the latter.
     def set_options(opts={})
+      opts = opts.dup
       %w(filename sitemaps_namer).each do |key|
         if value = opts.delete(key.to_sym)
           send("#{key}=", value)
@@ -332,12 +349,12 @@ module SitemapGenerator
     # If <tt>:public_path</tt> is present in +opts+ it is removed because groups cannot
     # change the public path.
     def options_for_group(opts)
-      opts.delete(:public_path)
-      SitemapGenerator::Utilities.reverse_merge!(opts,
+      opts = SitemapGenerator::Utilities.reverse_merge(opts,
         :include_index => false,
         :include_root => false,
         :sitemap_index => sitemap_index
       )
+      opts.delete(:public_path)
 
       # Reverse merge the current settings
       current_settings = [
@@ -384,7 +401,7 @@ module SitemapGenerator
     def finalize_sitemap!
       add_default_links if !@added_default_links && !@created_group
       return if sitemap.finalized? || sitemap.empty? && @created_group
-      sitemap_index.add(sitemap)
+      add_to_index(sitemap)
       output(sitemap.summary)
     end
 
@@ -543,7 +560,7 @@ module SitemapGenerator
       # Update the given attribute on the current sitemap index and sitemap file location objects.
       # But don't create the index or sitemap files yet if they are not already created.
       def update_location_info(attribute, value, opts={})
-        SitemapGenerator::Utilities.reverse_merge!(opts, :include_index => !@protect_index)
+        opts = SitemapGenerator::Utilities.reverse_merge(opts, :include_index => !@protect_index)
         @sitemap_index.location[attribute] = value if opts[:include_index] && @sitemap_index && !@sitemap_index.finalized?
         @sitemap.location[attribute] = value if @sitemap && !@sitemap.finalized?
       end

data/spec/sitemap_generator/interpreter_spec.rb

@@ -2,6 +2,9 @@ require 'spec_helper'
 require 'sitemap_generator/interpreter'
 
 describe SitemapGenerator::Interpreter do
+  let(:link_set)    { SitemapGenerator::LinkSet.new }
+  let(:interpreter) { SitemapGenerator::Interpreter.new(:link_set => link_set) }
+
   # The interpreter doesn't have the URL helpers included for some reason, so it
   # fails when adding links.  That messes up later specs unless we reset the sitemap object.
   after :all do
@@ -21,4 +24,67 @@ describe SitemapGenerator::Interpreter do
     interpreter = SitemapGenerator::Interpreter.run(:verbose => true)
     interpreter.instance_variable_get(:@linkset).verbose.should be_true
   end
+
+  describe "link_set" do
+    it "should default to the default LinkSet" do
+      SitemapGenerator::Interpreter.new.sitemap.should be(SitemapGenerator::Sitemap)
+    end
+
+    it "should allow setting the LinkSet as an option" do
+      interpreter.sitemap.should be(link_set)
+    end
+  end
+
+  describe "public interface" do
+    describe "add" do
+      it "should add a link to the sitemap" do
+        link_set.expects(:add).with('test', :option => 'value')
+        interpreter.add('test', :option => 'value')
+      end
+    end
+
+    describe "group" do
+      it "should start a new group" do
+        link_set.expects(:group).with('test', :option => 'value')
+        interpreter.group('test', :option => 'value')
+      end
+    end
+
+    describe "sitemap" do
+      it "should return the LinkSet" do
+        interpreter.sitemap.should be(link_set)
+      end
+    end
+    
+    describe "add_to_index" do
+      it "should add a link to the sitemap index" do
+        link_set.expects(:add_to_index).with('test', :option => 'value')
+        interpreter.add_to_index('test', :option => 'value')
+      end
+    end
+  end
+
+  describe "eval" do
+    it "should yield the LinkSet to the block" do
+      interpreter.eval(:yield_sitemap => true) do |sitemap|
+        sitemap.should be(link_set)
+      end
+    end
+
+    it "should not yield the LinkSet to the block" do
+      local = interpreter         # prevent undefined method
+      local_be = self.method(:be) # prevent undefined method
+      local.eval(:yield_sitemap => false) do
+        self.should local_be.call(local)
+      end
+    end
+
+    it "should not yield the LinkSet to the block by default" do
+      local = interpreter         # prevent undefined method
+      local_be = self.method(:be) # prevent undefined method
+      local.eval do
+        self.should local_be.call(local)
+      end
+    end
+  end
 end

data/spec/sitemap_generator/link_set_spec.rb

@@ -1,10 +1,8 @@
 require 'spec_helper'
 
 describe SitemapGenerator::LinkSet do
-  before :each do
-    @default_host = 'http://example.com'
-    @ls = SitemapGenerator::LinkSet.new
-  end
+  let(:default_host) { 'http://example.com' }
+  let(:ls)           { SitemapGenerator::LinkSet.new(:default_host => default_host) }
 
   describe "initializer options" do
     options = [:public_path, :sitemaps_path, :default_host, :filename, :search_engines]
@@ -12,13 +10,15 @@ describe SitemapGenerator::LinkSet do
 
     options.zip(values).each do |option, value|
       it "should set #{option} to #{value}" do
-        @ls = SitemapGenerator::LinkSet.new(option => value)
-        @ls.send(option).should == value
+        ls = SitemapGenerator::LinkSet.new(option => value)
+        ls.send(option).should == value
       end
     end
   end
 
   describe "default options" do
+    let(:ls) { SitemapGenerator::LinkSet.new }
+
     default_options = {
       :filename => :sitemap,
       :sitemaps_path => nil,
@@ -30,84 +30,84 @@ describe SitemapGenerator::LinkSet do
 
     default_options.each do |option, value|
       it "#{option} should default to #{value}" do
-        @ls.send(option).should == value
+        ls.send(option).should == value
       end
     end
   end
 
   describe "include_root include_index option" do
     it "should not include the root url" do
-      @ls = SitemapGenerator::LinkSet.new(:default_host => @default_host, :include_root => false)
-      @ls.include_root.should be_false
-      @ls.include_index.should be_true
-      @ls.add_links { |sitemap| }
-      @ls.sitemap.link_count.should == 1
+      ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :include_root => false)
+      ls.include_root.should be_false
+      ls.include_index.should be_true
+      ls.add_links { |sitemap| }
+      ls.sitemap.link_count.should == 1
     end
 
     it "should not include the sitemap index url" 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.sitemap.link_count.should == 1
+      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.sitemap.link_count.should == 1
     end
 
     it "should not include the root url or the sitemap index url" 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.sitemap.link_count.should == 0
+      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.sitemap.link_count.should == 0
     end
   end
 
   describe "sitemaps public_path" do
     it "should default to public/" do
-      @ls.public_path.should ==  SitemapGenerator.app.root + 'public/'
-      @ls.sitemap.location.public_path.should == @ls.public_path
-      @ls.sitemap_index.location.public_path.should == @ls.public_path
+      ls.public_path.should ==  SitemapGenerator.app.root + 'public/'
+      ls.sitemap.location.public_path.should == ls.public_path
+      ls.sitemap_index.location.public_path.should == ls.public_path
     end
 
     it "should change when the public_path is changed" do
-      @ls.public_path = 'tmp'
-      @ls.sitemap.location.public_path.should == @ls.public_path
-      @ls.sitemap_index.location.public_path.should == @ls.public_path
+      ls.public_path = 'tmp'
+      ls.sitemap.location.public_path.should == ls.public_path
+      ls.sitemap_index.location.public_path.should == ls.public_path
     end
   end
 
   describe "sitemaps url" do
     it "should change when the default_host is changed" do
-      @ls.default_host = 'http://one.com'
-      @ls.default_host.should == 'http://one.com'
-      @ls.default_host.should == @ls.sitemap.location.host
-      @ls.default_host.should == @ls.sitemap_index.location.host
+      ls.default_host = 'http://one.com'
+      ls.default_host.should == 'http://one.com'
+      ls.default_host.should == ls.sitemap.location.host
+      ls.default_host.should == ls.sitemap_index.location.host
     end
 
     it "should change when the sitemaps_path is changed" do
-      @ls.default_host = 'http://one.com'
-      @ls.sitemaps_path = 'sitemaps/'
-      @ls.sitemap.location.url.should == 'http://one.com/sitemaps/sitemap1.xml.gz'
-      @ls.sitemap_index.location.url.should == 'http://one.com/sitemaps/sitemap_index.xml.gz'
+      ls.default_host = 'http://one.com'
+      ls.sitemaps_path = 'sitemaps/'
+      ls.sitemap.location.url.should == 'http://one.com/sitemaps/sitemap1.xml.gz'
+      ls.sitemap_index.location.url.should == 'http://one.com/sitemaps/sitemap_index.xml.gz'
     end
   end
 
   describe "sitemap_index_url" do
     it "should return the url to the index file" do
-      @ls.default_host = @default_host
-      @ls.sitemap_index.location.url.should == "#{@default_host}/sitemap_index.xml.gz"
-      @ls.sitemap_index_url.should == @ls.sitemap_index.location.url
+      ls.default_host = default_host
+      ls.sitemap_index.location.url.should == "#{default_host}/sitemap_index.xml.gz"
+      ls.sitemap_index_url.should == ls.sitemap_index.location.url
     end
   end
 
   describe "search_engines" do
     it "should have search engines by default" do
-      @ls.search_engines.should be_a(Hash)
-      @ls.search_engines.size.should == 4
+      ls.search_engines.should be_a(Hash)
+      ls.search_engines.size.should == 4
     end
 
     it "should support being modified" do
-      @ls.search_engines[:newengine] = 'abc'
-      @ls.search_engines.size.should == 5
+      ls.search_engines[:newengine] = 'abc'
+      ls.search_engines.size.should == 5
     end
 
     it "should support being set to nil" do
@@ -121,13 +121,9 @@ describe SitemapGenerator::LinkSet do
   end
 
   describe "ping search engines" do
-    before do
-      @ls = SitemapGenerator::LinkSet.new :default_host => 'http://one.com'
-    end
-
     it "should not fail" do
-      @ls.expects(:open).at_least_once
-      lambda { @ls.ping_search_engines }.should_not raise_error
+      ls.expects(:open).at_least_once
+      lambda { ls.ping_search_engines }.should_not raise_error
     end
 
     it "should raise if no host is set" do
@@ -143,7 +139,7 @@ describe SitemapGenerator::LinkSet do
 
     it "should use the sitemap index url from the link set" do
       ls = SitemapGenerator::LinkSet.new(
-        :default_host => 'http://one.com',
+        :default_host => default_host,
         :search_engines => { :google => 'http://google.com/?url=%s' })
       index_url = ls.sitemap_index_url
       ls.expects(:open).with("http://google.com/?url=#{CGI.escape(index_url)}")
@@ -151,30 +147,26 @@ describe SitemapGenerator::LinkSet do
     end
 
     it "should include the given search engines" do
-      @ls.search_engines = nil
-      @ls.expects(:open).with(regexp_matches(/^http:\/\/newnegine\.com\?/))
-      @ls.ping_search_engines(:newengine => 'http://newnegine.com?%s')
+      ls.search_engines = nil
+      ls.expects(:open).with(regexp_matches(/^http:\/\/newnegine\.com\?/))
+      ls.ping_search_engines(:newengine => 'http://newnegine.com?%s')
 
-      @ls.expects(:open).with(regexp_matches(/^http:\/\/newnegine\.com\?/)).twice
-      @ls.ping_search_engines(:newengine => 'http://newnegine.com?%s', :anotherengine => 'http://newnegine.com?%s')
+      ls.expects(:open).with(regexp_matches(/^http:\/\/newnegine\.com\?/)).twice
+      ls.ping_search_engines(:newengine => 'http://newnegine.com?%s', :anotherengine => 'http://newnegine.com?%s')
     end
   end
 
   describe "verbose" do
-    before do
-      @ls = SitemapGenerator::LinkSet.new(:default_host => 'http://one.com')
-    end
-
     it "should be set as an initialize option" do
-      SitemapGenerator::LinkSet.new(:default_host => 'http://one.com', :verbose => false).verbose.should be_false
-      SitemapGenerator::LinkSet.new(:default_host => 'http://one.com', :verbose => true).verbose.should be_true
+      SitemapGenerator::LinkSet.new(:default_host => default_host, :verbose => false).verbose.should be_false
+      SitemapGenerator::LinkSet.new(:default_host => default_host, :verbose => true).verbose.should be_true
     end
 
     it "should be set as an accessor" do
-      @ls.verbose = true
-      @ls.verbose.should be_true
-      @ls.verbose = false
-      @ls.verbose.should be_false
+      ls.verbose = true
+      ls.verbose.should be_true
+      ls.verbose = false
+      ls.verbose.should be_false
     end
 
     it "should use SitemapGenerator.verbose as a default" do
@@ -182,54 +174,49 @@ describe SitemapGenerator::LinkSet do
       SitemapGenerator::LinkSet.new.verbose.should be_true
       SitemapGenerator.expects(:verbose).returns(false).at_least_once
       SitemapGenerator::LinkSet.new.verbose.should be_false
-    end   
+    end
   end
 
   describe "when finalizing" do
-    before do
-      @ls = SitemapGenerator::LinkSet.new(:default_host => 'http://one.com', :verbose => true)
-    end
+    let(:ls) { SitemapGenerator::LinkSet.new(:default_host => default_host, :verbose => true) }
 
     it "should output summary lines" do
-      @ls.sitemap.expects(:finalize!)
-      @ls.sitemap.expects(:summary)
-      @ls.sitemap_index.expects(:finalize!)
-      @ls.sitemap_index.expects(:summary)
-      @ls.finalize!
+      ls.sitemap.expects(:finalize!)
+      ls.sitemap.expects(:summary)
+      ls.sitemap_index.expects(:finalize!)
+      ls.sitemap_index.expects(:summary)
+      ls.finalize!
     end
   end
 
   describe "sitemaps host" do
-    before do
-      @new_host = 'http://wowza.com'
-      @ls = SitemapGenerator::LinkSet.new(:default_host => @default_host)
-    end
+    let(:new_host) { 'http://wowza.com' }
 
     it "should have a host" do
-      @ls.default_host = @default_host
-      @ls.default_host.should == @default_host
+      ls.default_host = default_host
+      ls.default_host.should == default_host
     end
 
     it "should default to default host" do
-      @ls.sitemaps_host.should == @ls.default_host
+      ls.sitemaps_host.should == ls.default_host
     end
 
     it "should update the host in the sitemaps when changed" do
-      @ls.sitemaps_host = @new_host
-      @ls.sitemaps_host.should == @new_host
-      @ls.sitemap.location.host.should == @ls.sitemaps_host
-      @ls.sitemap_index.location.host.should == @ls.sitemaps_host
+      ls.sitemaps_host = new_host
+      ls.sitemaps_host.should == new_host
+      ls.sitemap.location.host.should == ls.sitemaps_host
+      ls.sitemap_index.location.host.should == ls.sitemaps_host
     end
 
     it "should not change the default host for links" do
-      @ls.sitemaps_host = @new_host
-      @ls.default_host.should == @default_host
+      ls.sitemaps_host = new_host
+      ls.default_host.should == default_host
     end
   end
 
   describe "with a sitemap index specified" do
     before :each do
-      @index = SitemapGenerator::Builder::SitemapIndexFile.new(:host => @default_host)
+      @index = SitemapGenerator::Builder::SitemapIndexFile.new(:host => default_host)
       @ls = SitemapGenerator::LinkSet.new(:sitemap_index => @index, :sitemaps_host => 'http://newhost.com')
     end
 
@@ -242,7 +229,7 @@ describe SitemapGenerator::LinkSet do
     it "should not modify the index" do
       @ls.sitemaps_host = 'http://newhost.com'
       @ls.sitemap.location.host.should == 'http://newhost.com'
-      @ls.sitemap_index.location.host.should == @default_host
+      @ls.sitemap_index.location.host.should == default_host
     end
 
     it "should not finalize the index" do
@@ -252,55 +239,51 @@ describe SitemapGenerator::LinkSet do
   end
 
   describe "new group" do
-    before :each do
-      @ls = SitemapGenerator::LinkSet.new(:default_host => @default_host)
-    end
-
     describe "general behaviour" do
       it "should return a LinkSet" do
-        @ls.group.should be_a(SitemapGenerator::LinkSet)
+        ls.group.should be_a(SitemapGenerator::LinkSet)
       end
 
       it "should inherit the index" do
-        @ls.group.sitemap_index.should == @ls.sitemap_index
+        ls.group.sitemap_index.should == ls.sitemap_index
       end
 
       it "should protect the sitemap_index" do
-        @ls.group.instance_variable_get(:@protect_index).should be_true
+        ls.group.instance_variable_get(:@protect_index).should be_true
       end
 
       it "should not allow chaning the public_path" do
-        @ls.group(:public_path => 'new/path/').public_path.to_s.should == @ls.public_path.to_s
+        ls.group(:public_path => 'new/path/').public_path.to_s.should == ls.public_path.to_s
       end
     end
 
     describe "include_index" do
       it "should set the value" do
-        @ls.group(:include_index => !@ls.include_index).include_index.should_not == @ls.include_index
+        ls.group(:include_index => !ls.include_index).include_index.should_not == ls.include_index
       end
 
       it "should default to false" do
-        @ls.group.include_index.should be_false
+        ls.group.include_index.should be_false
       end
     end
 
     describe "include_root" do
       it "should set the value" do
-        @ls.group(:include_root => !@ls.include_root).include_root.should_not == @ls.include_root
+        ls.group(:include_root => !ls.include_root).include_root.should_not == ls.include_root
       end
 
       it "should default to false" do
-        @ls.group.include_root.should be_false
+        ls.group.include_root.should be_false
       end
     end
 
     describe "filename" do
       it "should inherit the value" do
-        @ls.group.filename.should == :sitemap
+        ls.group.filename.should == :sitemap
       end
 
       it "should set the value" do
-        group = @ls.group(:filename => :xxx)
+        group = ls.group(:filename => :xxx)
         group.filename.should == :xxx
         group.sitemap.location.filename.should =~ /xxx/
       end
@@ -308,24 +291,24 @@ describe SitemapGenerator::LinkSet do
 
     describe "verbose" do
       it "should inherit the value" do
-        @ls.group.verbose.should == @ls.verbose
+        ls.group.verbose.should == ls.verbose
       end
 
       it "should set the value" do
-        @ls.group(:verbose => !@ls.verbose).verbose.should_not == @ls.verbose
+        ls.group(:verbose => !ls.verbose).verbose.should_not == ls.verbose
       end
     end
 
     describe "sitemaps_path" do
       it "should inherit the sitemaps_path" do
-        group = @ls.group
-        group.sitemaps_path.should == @ls.sitemaps_path
-        group.sitemap.location.sitemaps_path.should == @ls.sitemap.location.sitemaps_path
+        group = ls.group
+        group.sitemaps_path.should == ls.sitemaps_path
+        group.sitemap.location.sitemaps_path.should == ls.sitemap.location.sitemaps_path
       end
 
       it "should set the sitemaps_path" do
         path = 'new/path'
-        group = @ls.group(:sitemaps_path => path)
+        group = ls.group(:sitemaps_path => path)
         group.sitemaps_path.should == path
         group.sitemap.location.sitemaps_path.to_s.should == path
       end
@@ -333,12 +316,12 @@ describe SitemapGenerator::LinkSet do
 
     describe "default_host" do
       it "should inherit the default_host" do
-        @ls.group.default_host.should == @default_host
+        ls.group.default_host.should == default_host
       end
 
       it "should set the default_host" do
         host = 'http://defaulthost.com'
-        group = @ls.group(:default_host => host)
+        group = ls.group(:default_host => host)
         group.default_host.should == host
         group.sitemap.location.host.should == host
       end
@@ -347,31 +330,31 @@ describe SitemapGenerator::LinkSet do
     describe "sitemaps_host" do
       it "should set the sitemaps host" do
         @host = 'http://sitemaphost.com'
-        @group = @ls.group(:sitemaps_host => @host)
+        @group = ls.group(:sitemaps_host => @host)
         @group.sitemaps_host.should == @host
         @group.sitemap.location.host.should == @host
       end
 
       it "should finalize the sitemap if it is the only option" do
-        @ls.expects(:finalize_sitemap!)
-        @ls.group(:sitemaps_host => 'http://test.com') {}
+        ls.expects(:finalize_sitemap!)
+        ls.group(:sitemaps_host => 'http://test.com') {}
       end
 
       it "should use the same sitemaps_namer" do
-        @group = @ls.group(:sitemaps_host => 'http://test.com') {}
-        @group.sitemap.location.namer.should == @ls.sitemap.location.namer
+        @group = ls.group(:sitemaps_host => 'http://test.com') {}
+        @group.sitemap.location.namer.should == ls.sitemap.location.namer
       end
     end
 
     describe "sitemaps_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.sitemaps_namer.should == ls.sitemaps_namer
+        ls.group.sitemap.location.namer.should == ls.sitemaps_namer
       end
 
       it "should set the value" do
         namer = SitemapGenerator::SitemapNamer.new(:xxx)
-        group = @ls.group(:sitemaps_namer => namer)
+        group = ls.group(:sitemaps_namer => namer)
         group.sitemaps_namer.should == namer
         group.sitemap.location.namer.should == namer
         group.sitemap.location.filename.should =~ /xxx/
@@ -380,8 +363,8 @@ describe SitemapGenerator::LinkSet do
 
     describe "should share the current sitemap" do
       it "if only default_host is passed" do
-        group = @ls.group(:default_host => 'http://newhost.com')
-        group.sitemap.should == @ls.sitemap
+        group = ls.group(:default_host => 'http://newhost.com')
+        group.sitemap.should == ls.sitemap
         group.sitemap.location.host.should == 'http://newhost.com'
       end
     end
@@ -394,26 +377,26 @@ describe SitemapGenerator::LinkSet do
         :sitemaps_namer => SitemapGenerator::SitemapNamer.new(:sitemap)
       }.each do |key, value|
         it "if #{key} is present" do
-          @ls.group(key => value).sitemap.should_not == @ls.sitemap
+          ls.group(key => value).sitemap.should_not == ls.sitemap
         end
       end
     end
 
     describe "finalizing" do
       it "should finalize the sitemaps if a block is passed" do
-        @group = @ls.group
+        @group = ls.group
         @group.sitemap.finalized?.should be_false
       end
 
       it "should only finalize the sitemaps if a block is passed" do
-        @group = @ls.group
+        @group = ls.group
         @group.sitemap.finalized?.should be_false
       end
 
       it "should not finalize the sitemap if a group is created" do
-        @ls.create { group {} }
-        @ls.sitemap.empty?.should be_true
-        @ls.sitemap.finalized?.should be_false
+        ls.create { group {} }
+        ls.sitemap.empty?.should be_true
+        ls.sitemap.finalized?.should be_false
       end
 
       {:sitemaps_path => 'en/',
@@ -421,86 +404,81 @@ describe SitemapGenerator::LinkSet do
         :sitemaps_namer => SitemapGenerator::SitemapNamer.new(:sitemap)}.each do |k, v|
 
         it "should not finalize the sitemap if #{k} is present" do
-          @ls.expects(:finalize_sitemap!).never
-          @ls.group(k => v) { }
+          ls.expects(:finalize_sitemap!).never
+          ls.group(k => v) { }
         end
       end
     end
   end
 
   describe "after create" do
-    before :each do
-      @ls = SitemapGenerator::LinkSet.new :default_host => @default_host
-    end
-
     it "should finalize the sitemap index" do
-      @ls.create {}
-      @ls.sitemap_index.finalized?.should be_true
+      ls.create {}
+      ls.sitemap_index.finalized?.should be_true
     end
 
     it "should finalize the sitemap" do
-      @ls.create {}
-      @ls.sitemap.finalized?.should be_true
+      ls.create {}
+      ls.sitemap.finalized?.should be_true
     end
 
     it "should not finalize the sitemap if a group was created" do
-      @ls.instance_variable_set(:@created_group, true)
-      @ls.send(:finalize_sitemap!)
-      @ls.sitemap.finalized?.should be_false
+      ls.instance_variable_set(:@created_group, true)
+      ls.send(:finalize_sitemap!)
+      ls.sitemap.finalized?.should be_false
     end
   end
 
   describe "options to create" do
     before :each do
-      @ls = SitemapGenerator::LinkSet.new(:default_host => @default_host)
-      @ls.expects(:finalize!)
+      ls.stubs(:finalize!)
     end
 
     it "should set include_index" do
-      original = @ls.include_index
-      @ls.create(:include_index => !original).include_index.should_not == original
+      original = ls.include_index
+      ls.create(:include_index => !original).include_index.should_not == original
     end
 
     it "should set include_root" do
-      original = @ls.include_root
-      @ls.create(:include_root => !original).include_root.should_not == original
+      original = ls.include_root
+      ls.create(:include_root => !original).include_root.should_not == original
     end
 
     it "should set the filename" do
-      ls = @ls.create(:filename => :xxx)
+      ls.create(:filename => :xxx)
       ls.filename.should == :xxx
       ls.sitemap.location.filename.should =~ /xxx/
     end
 
     it "should set verbose" do
-      original = @ls.verbose
-      @ls.create(:verbose => !original).verbose.should_not == original
+      original = ls.verbose
+      ls.create(:verbose => !original).verbose.should_not == original
     end
 
     it "should set the sitemaps_path" do
       path = 'new/path'
-      ls = @ls.create(:sitemaps_path => path)
+      ls.create(:sitemaps_path => path)
       ls.sitemaps_path.should == path
       ls.sitemap.location.sitemaps_path.to_s.should == path
     end
 
     it "should set the default_host" do
       host = 'http://defaulthost.com'
-      ls = @ls.create(:default_host => host)
+      ls.create(:default_host => host)
       ls.default_host.should == host
       ls.sitemap.location.host.should == host
     end
 
     it "should set the sitemaps host" do
-      @host = 'http://sitemaphost.com'
-      ls = @ls.create(:sitemaps_host => @host)
-      ls.sitemaps_host.should == @host
-      ls.sitemap.location.host.should == @host
+      host = 'http://sitemaphost.com'
+      ls.create(:sitemaps_host => host)
+      ls.sitemaps_host.should == host
+      ls.sitemap.location.host.should == host
     end
 
     it "should set the sitemaps_namer" do
       namer = SitemapGenerator::SitemapNamer.new(:xxx)
-      ls = @ls.create(:sitemaps_namer => namer)
+      ls.create(:sitemaps_namer => namer)
       ls.sitemaps_namer.should == namer
       ls.sitemap.location.namer.should == namer
       ls.sitemap.location.filename.should =~ /xxx/
@@ -508,7 +486,7 @@ describe SitemapGenerator::LinkSet do
 
     it "should support both sitemaps_namer and filename options" do
       namer = SitemapGenerator::SitemapNamer.new("sitemap1_")
-      ls = @ls.create(:sitemaps_namer => namer, :filename => "sitemap1")
+      ls.create(:sitemaps_namer => namer, :filename => "sitemap1")
       ls.sitemaps_namer.should == namer
       ls.sitemap.location.namer.should == namer
       ls.sitemap.location.filename.should =~ /sitemap1_1/
@@ -520,10 +498,16 @@ describe SitemapGenerator::LinkSet do
       options = {} #ActiveSupport::OrderedHash.new
       options[:sitemaps_namer] = namer
       options[:filename] = "sitemap1"
-      ls = @ls.create(options)
+      ls.create(options)
       ls.sitemap.location.filename.should =~ /sitemap1_1/
       ls.sitemap_index.location.filename.should =~ /sitemap1_index/
     end
+
+    it "should not modify the options hash" do
+      options = { :filename => 'sitemaptest', :verbose => false }
+      ls.create(options)
+      options.should == { :filename => 'sitemaptest', :verbose => false }
+    end
   end
 
   describe "reset!" do
@@ -541,56 +525,50 @@ describe SitemapGenerator::LinkSet do
 
   describe "include_root?" do
     it "should return false" do
-      @ls.include_root = false
-      @ls.include_root.should be_false
+      ls.include_root = false
+      ls.include_root.should be_false
     end
 
     it "should return true" do
-      @ls.include_root = true
-      @ls.include_root.should be_true
+      ls.include_root = true
+      ls.include_root.should be_true
     end
   end
 
   describe "include_index?" do
     let(:sitemaps_host)  { 'http://amazon.com' }
 
-    before :each do
-      @ls.default_host = @default_host
-    end
-
     it "should be true if no sitemaps_host set, or it is the same" do
-      @ls.include_index = true
-      @ls.sitemaps_host = @default_host
-      @ls.include_index?.should be_true
+      ls.include_index = true
+      ls.sitemaps_host = default_host
+      ls.include_index?.should be_true
 
-      @ls.sitemaps_host = nil
-      @ls.include_index?.should be_true
+      ls.sitemaps_host = nil
+      ls.include_index?.should be_true
     end
 
     it "should be false if include_index is false or sitemaps_host differs" do
-      @ls.include_index = false
-      @ls.sitemaps_host = @default_host
-      @ls.include_index?.should be_false
+      ls.include_index = false
+      ls.sitemaps_host = default_host
+      ls.include_index?.should be_false
 
-      @ls.include_index = true
-      @ls.sitemaps_host = sitemaps_host
-      @ls.include_index?.should be_false
+      ls.include_index = true
+      ls.sitemaps_host = sitemaps_host
+      ls.include_index?.should be_false
     end
 
     it "should return false" do
-      ls = SitemapGenerator::LinkSet.new(:default_host => @default_host, :sitemaps_host => sitemaps_host)
+      ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :sitemaps_host => sitemaps_host)
       ls.include_index?.should be_false
     end
 
     it "should return true" do
-      ls = SitemapGenerator::LinkSet.new(:default_host => @default_host, :sitemaps_host => @default_host)
+      ls = SitemapGenerator::LinkSet.new(:default_host => default_host, :sitemaps_host => default_host)
       ls.include_index?.should be_true
     end
   end
 
   describe "output" do
-    let(:ls) { SitemapGenerator::LinkSet.new }
-
     it "should not output" do
       ls.verbose = false
       ls.expects(:puts).never
@@ -603,4 +581,111 @@ describe SitemapGenerator::LinkSet do
       ls.send(:output, '')
     end
   end
+
+  describe "yield_sitemap" do
+    it "should default to the value of SitemapGenerator.yield_sitemap?" do
+      SitemapGenerator.expects(:yield_sitemap?).returns(true)
+      ls.yield_sitemap?.should be_true
+      SitemapGenerator.expects(:yield_sitemap?).returns(false)
+      ls.yield_sitemap?.should be_false
+    end
+
+    it "should be settable as an option" do
+      SitemapGenerator.expects(:yield_sitemap?).never
+      SitemapGenerator::LinkSet.new(:yield_sitemap => true).yield_sitemap?.should be_true
+      SitemapGenerator::LinkSet.new(:yield_sitemap => false).yield_sitemap?.should be_false
+    end
+
+    it "should be settable as an attribute" do
+      ls.yield_sitemap = true
+      ls.yield_sitemap?.should be_true
+      ls.yield_sitemap = false
+      ls.yield_sitemap?.should be_false
+    end
+
+    it "should yield the sitemap in the call to create" do
+      ls.send(:interpreter).expects(:eval).with(:yield_sitemap => true)
+      ls.yield_sitemap = true
+      ls.create
+      ls.send(:interpreter).expects(:eval).with(:yield_sitemap => false)
+      ls.yield_sitemap = false
+      ls.create
+    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' }
+      ls.add('/home', options)
+      options.should == { :host => 'http://newhost.com' }
+    end
+
+    it "should add the link to the sitemap and include the default host" do
+      ls.stubs(:add_default_links)
+      ls.sitemap.expects(:add).with('/home', :host => ls.default_host)
+      ls.add('/home')
+    end
+
+    it "should allow setting of a custom host" do
+      ls.stubs(:add_default_links)
+      ls.sitemap.expects(:add).with('/home', :host => 'http://newhost.com')
+      ls.add('/home', :host => 'http://newhost.com')
+    end
+
+    it "should add the default links if they have not been added" do
+      ls.expects(:add_default_links)
+      ls.add('/home')
+    end
+  end
+
+  describe "add_to_index", :focus do
+    it "should add the link to the sitemap index and pass options" do
+      ls.sitemap_index.expects(:add).with('/test', has_entry(:option => 'value'))
+      ls.add_to_index('/test', :option => 'value')
+    end
+
+    it "should not modify the options hash" do
+      options = { :host => 'http://newhost.com' }
+      ls.add_to_index('/home', options)
+      options.should == { :host => 'http://newhost.com' }
+    end
+
+    describe "host" do
+      it "should be the sitemaps_host" do
+        ls.sitemaps_host = 'http://sitemapshost.com'
+        ls.sitemap_index.expects(:add).with('/home', :host => 'http://sitemapshost.com')
+        ls.add_to_index('/home')
+      end
+
+      it "should be the default_host if no sitemaps_host set" do
+        ls.sitemap_index.expects(:add).with('/home', :host => ls.default_host)
+        ls.add_to_index('/home')
+      end
+
+      it "should allow setting a custom host" do
+        ls.sitemap_index.expects(:add).with('/home', :host => 'http://newhost.com')
+        ls.add_to_index('/home', :host => 'http://newhost.com')
+      end
+    end
+  end
 end