sitemap_generator 5.0.0 → 5.0.1

data/Gemfile.lock

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

data/README.md

@@ -117,6 +117,7 @@ That's it!  Welcome to the future!
 
 ## Changelog
 
+* v5.0.1: Include new `SitemapGenerator::FogAdapter` ([#138](https://github.com/kjvarga/sitemap_generator/pull/138)).  Fix usage of attr_* methods in LinkSet; don't override custom getters/setters ([#144](https://github.com/kjvarga/sitemap_generator/pull/144)). Fix breaking spec in Ruby 2 ([#142](https://github.com/kjvarga/sitemap_generator/pull/142)).  Include Capistrano 3.x tasks ([#141](https://github.com/kjvarga/sitemap_generator/pull/141)).
 * v5.0.0: Support new `:compress` option for customizing which files get compressed.  Remove old deprecated methods (see deprecation notices above).  Support `fog_path_style` option in the `SitemapGenerator::S3Adapter` so buckets with dots in the name work over HTTPS without SSL certificate problems.
 * v4.3.1: Support integer timestamps.  Update README for new features added in last release.
 * v4.3.0: Support `media` attibute on alternate links ([#125](https://github.com/kjvarga/sitemap_generator/issues/125)).  Changed `SitemapGenerator::S3Adapter` to write files in a single operation, avoiding potential permissions errors when listing a directory prior to writing ([#130](https://github.com/kjvarga/sitemap_generator/issues/130)).  Remove Sitemap Writer from ping task ([#129](https://github.com/kjvarga/sitemap_generator/issues/129)).  Support `url:expires` element ([#126](https://github.com/kjvarga/sitemap_generator/issues/126)).
@@ -297,34 +298,27 @@ SitemapGenerator::Interpreter.send :include, RoutingHelper
 
 ## Deployments & Capistrano
 
-To ensure that your application's sitemaps are available after a deployment you can do one of the following:
+To include the capistrano tasks just add the following to your Capfile:
 
-1.  **Generate sitemaps into a directory which is shared by all deployments.**
-    You can set your sitemaps path to your shared directory using the `sitemaps_path` option.  For example if we have a directory `public/shared/` that is shared by all deployments we can have our sitemaps generated into that directory by setting:
+```ruby
+require 'capistrano/sitemap_generator'
+```
 
-    ```ruby
-    SitemapGenerator::Sitemap.sitemaps_path = 'shared/'
-    ```
-2.  **Copy the sitemaps from the previous deploy over to the new deploy:**
-    (You will need to customize the task if you are using custom sitemap filenames or locations.)
-
-    ```ruby
-    after "deploy:update_code", "deploy:copy_old_sitemap"
-    namespace :deploy do
-      task :copy_old_sitemap do
-        run "if [ -e #{previous_release}/public/sitemap.xml.gz ]; then cp #{previous_release}/public/sitemap* #{current_release}/public/; fi"
-      end
-    end
-    ```
-3.  **Regenerate your sitemaps after each deployment:**
+Available capistrano tasks:
 
-    ```ruby
-    after "deploy", "refresh_sitemaps"
-    task :refresh_sitemaps do
-      run "cd #{latest_release} && RAILS_ENV=#{rails_env} rake sitemap:refresh"
-    end
-    ```
+```ruby
+deploy:sitemap:create   #Create sitemaps without pinging search engines
+deploy:sitemap:refresh  #Create sitemaps and ping search engines
+deploy:sitemap:clean    #Clean up sitemaps in the sitemap path
+```
+
+  **Generate sitemaps into a directory which is shared by all deployments.**
 
+  You can set your sitemaps path to your shared directory using the `sitemaps_path` option.  For example if we have a directory `public/shared/` that is shared by all deployments we can have our sitemaps generated into that directory by setting:
+
+```ruby
+SitemapGenerator::Sitemap.sitemaps_path = 'shared/'
+```
 
 ### Sitemaps with no Index File
 
@@ -351,11 +345,28 @@ And the default "intelligent" behaviour:
 SitemapGenerator::Sitemap.create_index = :auto
 ```
 
-### Upload Sitemaps to a Remote Host
+### Upload Sitemaps to a Remote Host using Adapters
+
+_This section needs better documentation.  Please consider contributing._
+
+#### Supported Adapters
+* `SitemapGenerator::FileAdapter`
+
+  Standard adapter, writes out to a file
+
+* `SitemapGenerator::FogAdapter`
+
+  Uses `fog` to upload to any service supported by Fog.
+
+* `SitemapGenerator::S3Adapter`
+
+  Uses `fog` to upload to Amazon S3 storage.
+
+* `SitemapGenerator::WaveAdapter`
+
+  Uses `carrierwave` to upload to any service supported by CarrierWave.
 
-> SitemapGenerator::S3Adapter is a simple S3 adapter which was added in v3.2 which
-> uses Fog and doesn't require CarrierWave.  You can find a bit more information
-> about it [on the wiki page][remote_hosts].
+Some documentation exists [on the wiki page][remote_hosts].
 
 Sometimes it is desirable to host your sitemap files on a remote server and point robots
 and search engines to the remote files.  For example if you are using a host like Heroku

data/VERSION

@@ -1 +1 @@
-5.0.0
+5.0.1

data/lib/capistrano/sitemap_generator.rb

@@ -0,0 +1 @@
+load File.expand_path(File.join('..', 'tasks', 'sitemap_generator.cap'), __FILE__)

data/lib/capistrano/tasks/sitemap_generator.cap

@@ -0,0 +1,36 @@
+namespace :deploy do
+  namespace :sitemap do
+    desc 'Create sitemap and ping search engines'
+    task :refresh do
+      on roles :web do
+        within release_path do
+          with rails_env: fetch(:rails_env) do
+           execute :rake, "sitemap:refresh"
+          end
+        end
+      end
+    end
+
+    desc 'Create sitemap without pinging search engines'
+    task :create do
+      on roles :web do
+        within release_path do
+          with rails_env: fetch(:rails_env) do
+           execute :rake, "sitemap:create"
+          end
+        end
+      end
+    end
+
+    desc 'Clean up sitemaps in sitemap_generator path'
+    task :clean do
+      on roles :web do
+        within release_path do
+          with rails_env: fetch(:rails_env) do
+           execute :rake, "sitemap:clean"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sitemap_generator.rb

@@ -12,6 +12,7 @@ module SitemapGenerator
   autoload(:FileAdapter, 'sitemap_generator/adapters/file_adapter')
   autoload(:S3Adapter,   'sitemap_generator/adapters/s3_adapter')
   autoload(:WaveAdapter, 'sitemap_generator/adapters/wave_adapter')
+  autoload(:FogAdapter,  'sitemap_generator/adapters/fog_adapter')
   autoload(:BigDecimal,  'sitemap_generator/core_ext/big_decimal')
   autoload(:Numeric,     'sitemap_generator/core_ext/numeric')
 

data/lib/sitemap_generator/adapters/fog_adapter.rb

@@ -0,0 +1,28 @@
+begin
+  require 'fog'
+rescue LoadError
+  raise LoadError.new("Missing required 'fog'.  Please 'gem install fog' and require it in your application.")
+end
+
+module SitemapGenerator
+  class FogAdapter
+
+    def initialize(opts = {})
+      @fog_credentials = opts[:fog_credentials]
+      @fog_directory = opts[:fog_directory]
+    end
+
+    # Call with a SitemapLocation and string data
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+
+      storage   = Fog::Storage.new(@fog_credentials)
+      directory = storage.directories.new(:key => @fog_directory)
+      directory.files.create(
+        :key    => location.path_in_public,
+        :body   => File.open(location.path),
+        :public => true
+      )
+    end
+  end
+end

data/lib/sitemap_generator/link_set.rb

@@ -8,7 +8,8 @@ module SitemapGenerator
     @@new_location_opts = [:filename, :sitemaps_path, :namer]
 
     attr_reader :default_host, :sitemaps_path, :filename, :create_index
-    attr_accessor :verbose, :yahoo_app_id, :include_root, :include_index, :sitemaps_host, :adapter, :yield_sitemap
+    attr_accessor :include_root, :include_index, :adapter, :yield_sitemap
+    attr_writer :verbose
 
     # Create a new sitemap index and sitemap files.  Pass a block with calls to the following
     # methods:

data/spec/sitemap_generator/helpers/number_helper_spec.rb

@@ -54,7 +54,12 @@ describe SitemapGenerator::Helpers::NumberHelper do
     number_with_precision(0, :precision => 0).should == "0"
     number_with_precision(0.001, :precision => 5).should == "0.00100"
     number_with_precision(0.00111, :precision => 3).should == "0.001"
-    number_with_precision(9.995, :precision => 2).should == "9.99"
+    # Odd difference between Ruby versions
+    if RUBY_VERSION < '1.9.3'
+      number_with_precision(9.995, :precision => 2).should == "9.99"
+    else
+      number_with_precision(9.995, :precision => 2).should == "10.00"
+    end
     number_with_precision(10.995, :precision => 2).should == "11.00"
   end
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 5
   - 0
-  - 0
-  version: 5.0.0
+  - 1
+  version: 5.0.1
 platform: ruby
 authors: 
 - Karl Varga
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-02-05 00:00:00 -08:00
+date: 2014-03-04 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,7 +84,10 @@ files:
 - Rakefile
 - README.md
 - VERSION
+- lib/capistrano/sitemap_generator.rb
+- lib/capistrano/tasks/sitemap_generator.cap
 - lib/sitemap_generator/adapters/file_adapter.rb
+- lib/sitemap_generator/adapters/fog_adapter.rb
 - lib/sitemap_generator/adapters/s3_adapter.rb
 - lib/sitemap_generator/adapters/wave_adapter.rb
 - lib/sitemap_generator/adapters.rb
@@ -174,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2638185396459765227
+      hash: 3343341669011167258
       segments: 
       - 0
       version: "0"
@@ -183,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -2638185396459765227
+      hash: 3343341669011167258
       segments: 
       - 0
       version: "0"