sitemap_generator 2.0.0 → 2.0.1.pre1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ./
   specs:
-    sitemap_generator (2.0.0)
+    sitemap_generator (2.0.1.pre1)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -26,6 +26,7 @@ Does your website use SitemapGenerator to generate Sitemaps?  Where would you be
 Changelog
 -------
 
+- v2.0.1: Minor improvements to verbose handling; prevent missing Timeout issue
 - **v2.0.0: Introducing a new simpler API, Sitemap Groups, Sitemap Namers and more!**
 - v1.5.0: New options `include_root`, `include_index`; Major testing & refactoring
 - v1.4.0: [Geo sitemap][geo_tags] support, multiple sitemap support via CONFIG_FILE rake option

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.0.1.pre1

data/lib/sitemap_generator.rb

@@ -4,12 +4,15 @@ require 'sitemap_generator/link_set'
 require 'sitemap_generator/templates'
 require 'sitemap_generator/utilities'
 require 'sitemap_generator/application'
+require 'sitemap_generator/adapters'
 require 'sitemap_generator/sitemap_location'
 require 'active_support/core_ext/numeric'
 
 module SitemapGenerator
   autoload(:Interpreter, 'sitemap_generator/interpreter')
-
+  autoload(:FileAdapter, 'sitemap_generator/adapters/file_adapter')
+  autoload(:WaveAdapter, 'sitemap_generator/adapters/wave_adapter')
+  
   SitemapError = Class.new(StandardError)
   SitemapFullError = Class.new(SitemapError)
   SitemapFinalizedError = Class.new(SitemapError)

data/lib/sitemap_generator/adapters/file_adapter.rb

@@ -0,0 +1,21 @@
+module SitemapGenerator
+  class FileAdapter
+    def write(location, raw_data)
+      # Ensure that the directory exists
+      dir = location.directory
+      if !File.exists?(dir)
+        FileUtils.mkdir_p(dir)
+      elsif !File.directory?(dir)
+        raise SitemapError.new("#{dir} should be a directory!")
+      end
+
+      gzip(open(location.path, 'wb'), raw_data)
+    end
+
+    def gzip(stream, data)
+      gz = Zlib::GzipWriter.new(stream)
+      gz.write data
+      gz.close
+    end
+  end
+end

data/lib/sitemap_generator/adapters/wave_adapter.rb

@@ -0,0 +1,13 @@
+require 'carrierwave'
+
+module SitemapGenerator
+  class WaveAdapter < ::CarrierWave::Uploader::Base
+    attr_accessor :store_dir
+    
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+      self.store_dir = File.dirname(location.path_in_public)
+      store!(open(location.path, 'rb'))
+    end
+  end
+end

data/lib/sitemap_generator/builder/sitemap_file.rb

@@ -93,22 +93,7 @@ module SitemapGenerator
       def finalize!
         raise SitemapGenerator::SitemapFinalizedError if finalized?
 
-        # Ensure that the directory exists
-        dir = @location.directory
-        if !File.exists?(dir)
-          FileUtils.mkdir_p(dir)
-        elsif !File.directory?(dir)
-          raise SitemapError.new("#{dir} should be a directory!")
-        end
-
-        # Write out the file
-        open(@location.path, 'wb') do |file|
-          gz = Zlib::GzipWriter.new(file)
-          gz.write @xml_wrapper_start
-          gz.write @xml_content
-          gz.write @xml_wrapper_end
-          gz.close
-        end
+        @location.write(@xml_wrapper_start + @xml_content + @xml_wrapper_end)
 
         # Increment the namer (SitemapFile only)
         @location.namer.next if @location.namer

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
+    attr_accessor :verbose, :yahoo_app_id, :include_root, :include_index, :sitemaps_host, :adapter
 
     # Add links to the link set by evaluating the block.  The block should
     # contains calls to sitemap methods like:
@@ -47,6 +47,9 @@ module SitemapGenerator
     # Constructor
     #
     # == Options:
+    # * <tt>:adapter</tt> - subclass of SitemapGenerator::Adapter used for persisting the
+    #   sitemaps.  Default adapter is a SitemapGenerator::FileAdapter
+    #
     # * <tt>:default_host</tt> - host including protocol to use in all sitemap links
     #   e.g. http://en.google.ca
     #
@@ -165,6 +168,7 @@ module SitemapGenerator
     # @see http://en.wikipedia.org/wiki/Sitemap_index
     def ping_search_engines
       require 'open-uri'
+      require 'timeout'
 
       sitemap_index_url = CGI.escape(sitemap_index.location.url)
       search_engines = {
@@ -393,7 +397,8 @@ module SitemapGenerator
           :host => sitemaps_host,
           :namer => sitemaps_namer,
           :public_path => public_path,
-          :sitemaps_path => @sitemaps_path
+          :sitemaps_path => @sitemaps_path,
+          :adapter => @adapter
         )
       end
 
@@ -403,7 +408,8 @@ module SitemapGenerator
           :host => sitemaps_host,
           :namer => sitemap_index_namer,
           :public_path => public_path,
-          :sitemaps_path => @sitemaps_path
+          :sitemaps_path => @sitemaps_path,
+          :adapter => @adapter
         )
       end
 

data/lib/sitemap_generator/sitemap_location.rb

@@ -1,7 +1,7 @@
 module SitemapGenerator
   class SitemapLocation < Hash
 
-    [:host].each do |method|
+    [:host, :adapter].each do |method|
       define_method(method) do
         raise SitemapGenerator::SitemapError, "No value set for #{method}" unless self[method]
         self[method]
@@ -18,18 +18,20 @@ module SitemapGenerator
     # files this generates names like <tt>sitemap1.xml.gz</tt>, <tt>sitemap2.xml.gz</tt> and so on,
     #
     # === Options
+    # * <tt>adapter</tt> - SitemapGenerator::Adapter subclass
+    # * <tt>filename</tt> - full name of the file e.g. <tt>'sitemap1.xml.gz'<tt>
+    # * <tt>host</tt> - host name for URLs.  The full URL to the file is then constructed from
+    #   the <tt>host</tt>, <tt>sitemaps_path</tt> and <tt>filename</tt>
+    # * <tt>namer</tt> - a SitemapGenerator::SitemapNamer instance.  Can be passed instead of +filename+.
     # * <tt>public_path</tt> - path to the "public" directory, or the directory you want to
     #   write sitemaps in.  Default is a directory <tt>public/</tt>
     #   in the current working directory, or relative to the Rails root
     #   directory if running under Rails.
     # * <tt>sitemaps_path</tt> - gives the path relative to the <tt>public_path</tt> in which to
     #   write sitemaps e.g. <tt>sitemaps/</tt>.
-    # * <tt>host</tt> - host name for URLs.  The full URL to the file is then constructed from
-    #   the <tt>host</tt>, <tt>sitemaps_path</tt> and <tt>filename</tt>
-    # * <tt>filename</tt> - full name of the file e.g. <tt>'sitemap1.xml.gz'<tt>
-    # * <tt>namer</tt> - a SitemapGenerator::SitemapNamer instance.  Can be passed instead of +filename+.
     def initialize(opts={})
-      SitemapGenerator::Utilities.assert_valid_keys(opts, [:public_path, :sitemaps_path, :host, :filename, :namer])
+      SitemapGenerator::Utilities.assert_valid_keys(opts, [:adapter, :public_path, :sitemaps_path, :host, :filename, :namer])
+      opts[:adapter] ||= SitemapGenerator::FileAdapter.new
       opts[:public_path] ||= SitemapGenerator.app.root + 'public/'
       opts[:namer] = SitemapGenerator::SitemapNamer.new(:sitemap) if !opts[:filename] && !opts[:namer]
       self.merge!(opts)
@@ -92,6 +94,10 @@ module SitemapGenerator
       end
       super(key, value)
     end
+
+    def write(data)
+      adapter.write(self, data)
+    end
   end
 
   class SitemapIndexLocation < SitemapLocation

data/tasks/sitemap_generator_tasks.rake

@@ -20,7 +20,7 @@ namespace :sitemap do
 
   desc "Install a default config/sitemap.rb file"
   task :install => ['sitemap:require'] do
-    SitemapGenerator::Utilities.install_sitemap_rb(verbose)
+    SitemapGenerator::Utilities.install_sitemap_rb(verbose.nil? ? true : false)
   end
 
   desc "Delete all Sitemap files in public/ directory"
@@ -28,15 +28,16 @@ namespace :sitemap do
     SitemapGenerator::Utilities.clean_files
   end
 
-  desc "Create Sitemap XML files in public/ directory (rake -s for no output)"
+  desc "Generate sitemaps and ping search engines."
   task :refresh => ['sitemap:create'] do
     SitemapGenerator::Sitemap.ping_search_engines
   end
 
-  desc "Create Sitemap XML files (don't ping search engines)"
+  desc "Generate sitemaps but don't ping search engines."
   task 'refresh:no_ping' => ['sitemap:create']
 
+  desc "Generate sitemaps but don't ping search engines.  Alias for refresh:no_ping."
   task :create => ['sitemap:require_environment'] do
-    SitemapGenerator::Interpreter.run(:config_file => ENV["CONFIG_FILE"], :verbose => verbose)
+    SitemapGenerator::Interpreter.run(:config_file => ENV["CONFIG_FILE"], :verbose => verbose.nil? ? true : false)
   end
-end
+end

metadata

@@ -1,13 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: sitemap_generator
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: 
+  hash: 1923832035
+  prerelease: 6
   segments: 
   - 2
   - 0
-  - 0
-  version: 2.0.0
+  - 1
+  - pre
+  - 1
+  version: 2.0.1.pre1
 platform: ruby
 authors: 
 - Karl Varga
@@ -16,12 +18,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-20 00:00:00 -07:00
+date: 2011-06-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :development
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -30,12 +31,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: rspec
-  version_requirements: *id001
+  requirement: *id001
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  name: rspec
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -44,12 +45,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: nokogiri
-  version_requirements: *id002
+  requirement: *id002
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  name: nokogiri
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -58,12 +59,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: sqlite3-ruby
-  version_requirements: *id003
+  requirement: *id003
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  name: sqlite3-ruby
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -72,12 +73,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: jeweler
-  version_requirements: *id004
+  requirement: *id004
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  name: jeweler
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -86,12 +87,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: github
-  version_requirements: *id005
+  requirement: *id005
   prerelease: false
-- !ruby/object:Gem::Dependency 
   type: :development
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  name: github
+- !ruby/object:Gem::Dependency 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -100,9 +101,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  name: git
-  version_requirements: *id006
+  requirement: *id006
   prerelease: false
+  type: :development
+  name: git
 description: SitemapGenerator is a Rails gem that makes it easy to generate enterprise-class Sitemaps readable by all search engines.  Generated Sitemaps adhere to the Sitemap protocol specification.  When you generate new Sitemaps, SitemapGenerator can automatically ping the major search engines (including Google, Yahoo and Bing) to notify them.  SitemapGenerator includes rake tasks to easily manage your sitemaps.
 email: kjvarga@gmail.com
 executables: []
@@ -119,6 +121,9 @@ files:
 - Rakefile
 - VERSION
 - lib/sitemap_generator.rb
+- lib/sitemap_generator/adapters.rb
+- lib/sitemap_generator/adapters/file_adapter.rb
+- lib/sitemap_generator/adapters/wave_adapter.rb
 - lib/sitemap_generator/application.rb
 - lib/sitemap_generator/builder.rb
 - lib/sitemap_generator/builder/sitemap_file.rb
@@ -158,12 +163,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: