sitemap_generator 6.3.0 → 7.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bd65e97e0a574eb1d124988e20c38312968548bf8ef8d381e648c54d6766d049
-  data.tar.gz: b9cbf014555cbdfb293c6e780a3e9ab4349db02f8fddbcddc28ab8c743f24657
+  metadata.gz: b26cd553fe4ecc452da26ac6aff3262238f065dc12d9f328959eb3c1edc79f6e
+  data.tar.gz: 877828e867880ed215df8b3e1f6acb130e4e8c5856a349e61e6af17a5c641ac9
 SHA512:
-  metadata.gz: 1ec50b44415503a1d3bce5859cf6b397592212c19827f6dc45019df221f3c08131a04f7e89db98d21172982d6ca212c901638c30882c9b4b08adc107fff67d95
-  data.tar.gz: 3afc709b82309f5c052fb00e8c467554c44cc974d7dc122ae45938d9b80c574236639c74b85058a1251c7fc5a2fd2fe827d8478619612f8c6ee0a5ef514d780f
+  metadata.gz: d957d69f7a4c2fe8e98cecb84045d58fe59f9f8143764c88695a7561a63d54e9d515c80bdc2b2cf496b1704ffb2ca4610b54f5889cb246e2ed45aac88029abdd
+  data.tar.gz: 884fc7be3809f6670cce09afdddfa64cdf6b4c5b25cdc7ad5c7c3b784d08f83bbc96bdb671a1b52de7f0f59fac8618f1bc83122c01664ee574a52c4edd791699

data/CHANGES.md

@@ -1,3 +1,19 @@
+### 7.0.1
+
+* **Breaking:** Default search engines list is empty. `rake sitemap:refresh` and `ping_search_engines` perform no HTTP pings unless you configure engine URLs on `search_engines` or pass them into `ping_search_engines` (Google’s ping endpoint is deprecated upstream). [#444](https://github.com/kjvarga/sitemap_generator/pull/444)
+* **Breaking:** `LinkSet#create` runs `finalize!` only when a block is given. Calling `create` without a block requires `finalize!` when you are done adding links (supported workflow for programmatic builds). [#463](https://github.com/kjvarga/sitemap_generator/pull/463)
+* **Breaking:** Drop Ruby 2.5, Rails 5.2 [#438](https://github.com/kjvarga/sitemap_generator/pull/438)
+* Migrate continuous integration from CircleCI to GitHub Actions with expanded Ruby × Rails CI matrix.
+* Support AWS temporary credentials (`aws_session_token` / `AWS_SESSION_TOKEN`) for S3 uploads in AWS Lambda [#415](https://github.com/kjvarga/sitemap_generator/pull/415)
+* Add `frozen_string_literal: true` magic comments [#430](https://github.com/kjvarga/sitemap_generator/pull/430)
+* Add support for Rails 8.0 [#441](https://github.com/kjvarga/sitemap_generator/pull/441)
+* Fix uninitialized constant ActiveSupport::LoggerThreadSafeLevel::Logger [#449](https://github.com/kjvarga/sitemap_generator/pull/449)
+* Add support for Ruby 3.4 [#451](https://github.com/kjvarga/sitemap_generator/pull/451)
+* Add support for Rails 8.1 [#461](https://github.com/kjvarga/sitemap_generator/pull/461)
+* Replace CGI-based escaping with `URI.encode_www_form_component` for ping URLs; remove reliance on `cgi` (Ruby 4 compatibility) [#465](https://github.com/kjvarga/sitemap_generator/pull/465)
+* Add support for Ruby 4.0 [#466](https://github.com/kjvarga/sitemap_generator/pull/466)
+* Add ActiveStorage adapter (`ActiveStorage::Blob`) [#467](https://github.com/kjvarga/sitemap_generator/pull/467)
+
 ### 6.3.0
 
 * Remove Bing's deprecated sitemap submission [#400](https://github.com/kjvarga/sitemap_generator/pull/400).

data/README.md

@@ -1,6 +1,6 @@
 # SitemapGenerator
 
-[![CircleCI](https://circleci.com/gh/kjvarga/sitemap_generator/tree/master.svg?style=shield)](https://circleci.com/gh/kjvarga/sitemap_generator/tree/master)
+[![CI](https://github.com/kjvarga/sitemap_generator/actions/workflows/ci.yml/badge.svg)](https://github.com/kjvarga/sitemap_generator/actions/workflows/ci.yml)
 
 SitemapGenerator is the easiest way to generate Sitemaps in Ruby.  Rails integration provides access to the Rails route helpers within your sitemap config file and automatically makes the rake tasks available to you.  Or if you prefer to use another framework, you can!  You can use the rake tasks provided or run your sitemap configs as plain ruby scripts.
 
@@ -11,14 +11,15 @@ Sitemaps adhere to the [Sitemap 0.9 protocol][sitemap_protocol] specification.
 * Framework agnostic
 * Supports [News sitemaps][sitemap_news], [Video sitemaps][sitemap_video], [Image sitemaps][sitemap_images], [Mobile sitemaps][sitemap_mobile], [PageMap sitemaps][sitemap_pagemap] and [Alternate Links][alternate_links]
 * Supports read-only filesystems like Heroku via uploading to a remote host like Amazon S3
-* Compatible with all versions of Rails and Ruby
 * Adheres to the [Sitemap 0.9 protocol][sitemap_protocol]
 * Handles millions of links
 * Customizable sitemap compression
-* Notifies search engines (Google) of new sitemaps
+* Optional HTTP notification of search engines when `search_engines` is configured
 * Ensures your old sitemaps stay in place if the new sitemap fails to generate
 * Gives you complete control over your sitemap contents and naming scheme
 * Intelligent sitemap indexing
+* Compatible with Ruby from version 2.6 to version 4.0
+* Compatible with Rails from version 6.0 to version 8.1
 
 ### Show Me
 
@@ -41,7 +42,6 @@ SitemapGenerator::Sitemap.create do
   add '/home', :changefreq => 'daily', :priority => 0.9
   add '/contact_us', :changefreq => 'weekly'
 end
-SitemapGenerator::Sitemap.ping_search_engines # Not needed if you use the rake tasks
 ```
 
 Run it:
@@ -56,8 +56,6 @@ Output:
 In /Users/karl/projects/sitemap_generator-test/public/
 + sitemap.xml.gz                                           3 links /  364 Bytes
 Sitemap stats: 3 links / 1 sitemaps / 0m00s
-
-Successful ping of Google
 ```
 
 ## Contents
@@ -66,7 +64,6 @@ Successful ping of Google
   - [Features](#features)
     - [Show Me](#show-me)
   - [Contents](#contents)
-  - [Contribute](#contribute)
   - [Foreword](#foreword)
   - [Installation](#installation)
     - [Ruby](#ruby)
@@ -78,11 +75,12 @@ Successful ping of Google
     - [Crontab](#crontab)
     - [Robots.txt](#robotstxt)
     - [Ruby Modules](#ruby-modules)
-    - [Deployments & Capistrano](#deployments--capistrano)
+    - [Deployments \& Capistrano](#deployments--capistrano)
     - [Sitemaps with no Index File](#sitemaps-with-no-index-file)
     - [Upload Sitemaps to a Remote Host using Adapters](#upload-sitemaps-to-a-remote-host-using-adapters)
       - [Supported Adapters](#supported-adapters)
         - [`SitemapGenerator::FileAdapter`](#sitemapgeneratorfileadapter)
+        - [`SitemapGenerator::ActiveStorageAdapter`](#sitemapgeneratoractivestorageadapter)
         - [`SitemapGenerator::FogAdapter`](#sitemapgeneratorfogadapter)
         - [`SitemapGenerator::S3Adapter`](#sitemapgenerators3adapter)
         - [`SitemapGenerator::AwsSdkAdapter`](#sitemapgeneratorawssdkadapter)
@@ -96,6 +94,7 @@ Successful ping of Google
     - [Supported Options to `add`](#supported-options-to-add)
     - [Adding Links to the Sitemap Index](#adding-links-to-the-sitemap-index)
     - [Accessing the LinkSet instance](#accessing-the-linkset-instance)
+    - [Using `create` without a block](#using-create-without-a-block)
     - [Speeding Things Up](#speeding-things-up)
   - [Customizing your Sitemaps](#customizing-your-sitemaps)
     - [Sitemap Options](#sitemap-options)
@@ -125,13 +124,6 @@ Successful ping of Google
   - [Compatibility](#compatibility)
   - [Licence](#licence)
 
-## Contribute
-
-Does your website use SitemapGenerator to generate Sitemaps?  Where would you be without Sitemaps?  Probably still knocking rocks together.  Consider donating to the project to keep it up-to-date and open source.
-
-<a href='http://www.pledgie.com/campaigns/15267'><img alt='Click here to lend your support to: SitemapGenerator and make a donation at www.pledgie.com !' src='http://pledgie.com/campaigns/15267.png?skin_name=chrome' border='0' /></a>
-
-
 ## Foreword
 
 Adam Salter first created SitemapGenerator while we were working together in Sydney, Australia.  Unfortunately, he passed away in 2009.  Since then I have taken over development of SitemapGenerator.
@@ -159,7 +151,7 @@ The Rake tasks expect your sitemap to be at `config/sitemap.rb` but if you need
 
 ### Rails
 
-SitemapGenerator works with all versions of Rails and has been tested in Rails 2, 3 and 4.
+SitemapGenerator targets Rails 6.0 through 8.1 (see [Compatibility](#compatibility)).
 
 Add the gem to your `Gemfile`:
 
@@ -204,10 +196,10 @@ SitemapGenerator.verbose = false
 
 ### Pinging Search Engines
 
-Using `rake sitemap:refresh` will notify Google to let them know that a new sitemap
+Using `rake sitemap:refresh` will notify configured search engines to let them know that a new sitemap
 is available.  To generate new sitemaps without notifying search engines, use `rake sitemap:refresh:no_ping`.
 
-If you want to customize the hash of search engines you can access it at:
+By default no search engines are configured. If you want to customize the hash of search engines you can access it at:
 
 ```ruby
 SitemapGenerator::Sitemap.search_engines
@@ -224,7 +216,7 @@ directly in the call, as in the following example:
 SitemapGenerator::Sitemap.ping_search_engines(newengine: 'http://newengine.com/ping?url=%s')
 ```
 
-The key gives the name of the search engine, as a string or symbol, and the value is the full URL to ping, with a string interpolation that will be replaced by the CGI escaped sitemap index URL.  If you have any literal percent characters in your URL you need to escape them with `%%`.
+The key gives the name of the search engine, as a string or symbol, and the value is the full URL to ping, with a string interpolation that will be replaced by the URL-encoded (percent-encoded) sitemap index URL.  If you have any literal percent characters in your URL you need to escape them with `%%`.
 
 If you are calling `SitemapGenerator::Sitemap.ping_search_engines` from outside of your sitemap config file, then you will need to set `SitemapGenerator::Sitemap.default_host` and any other options that you set in your sitemap config which affect the location of the sitemap index file.  For example:
 
@@ -342,6 +334,10 @@ directory.
 
   Standard adapter, writes out to a file.
 
+##### `SitemapGenerator::ActiveStorageAdapter`
+
+  Uses `ActiveStorage::Blob` to store the sitemap.
+
 ##### `SitemapGenerator::FogAdapter`
 
   Uses `Fog::Storage` to upload to any service supported by Fog.
@@ -364,6 +360,7 @@ directory.
   Where `options` is a Hash with any of the following keys:
 * `aws_access_key_id` [String] Your AWS access key id
 * `aws_secret_access_key` [String] Your AWS secret access key
+* `aws_session_token` [String] Session token for temporary credentials (optional)
 * `fog_provider` [String]
 * `fog_directory` [String]
 * `fog_region` [String]
@@ -372,7 +369,7 @@ directory.
 * `fog_public` [Boolean] Whether the file is publicly accessible
 
 Alternatively you can use an environment variable to configure each option (except `fog_storage_options`).  The environment variables have the same
-name but capitalized, e.g. `FOG_PATH_STYLE`.
+name but capitalized, e.g. `AWS_SESSION_TOKEN`, `FOG_PATH_STYLE`.
 
 ##### `SitemapGenerator::AwsSdkAdapter`
 
@@ -388,14 +385,15 @@ name but capitalized, e.g. `FOG_PATH_STYLE`.
   SitemapGenerator::Sitemap.adapter = SitemapGenerator::AwsSdkAdapter.new('s3_bucket',
     acl: 'public-read', # Optional. This is the default.
     cache_control: 'private, max-age=0, no-cache', # Optional. This is the default.
-    access_key_id: 'AKIAI3SW5CRAZBL4WSTA',
-    secret_access_key: 'asdfadsfdsafsadf',
+    access_key_id: 'YOUR_AWS_ACCESS_KEY_ID',
+    secret_access_key: 'YOUR_AWS_SECRET_ACCESS_KEY',
+    session_token: 'YOUR_AWS_SESSION_TOKEN', # Optional; use with temporary credentials.
     region: 'us-east-1',
     endpoint: 'https://sfo2.digitaloceanspaces.com'
   )
   ```
 
-  Where the first argument is the S3 bucket name, and the rest are keyword argument options.  Options `:acl` and `:cache_control` configure access and caching of the uploaded files; all other options are passed directly to the AWS client.
+  Where the first argument is the S3 bucket name, and the rest are keyword argument options.  Options `:acl` and `:cache_control` configure access and caching of the uploaded files; `session_token` supports STS-style credentials (or set `AWS_SESSION_TOKEN` and rely on SDK defaults). All other keyword options are passed directly to the AWS client.
 
   See [the `SitemapGenerator::AwsSdkAdapter` docs](https://github.com/kjvarga/sitemap_generator/blob/master/lib/sitemap_generator/adapters/aws_sdk_adapter.rb), and [https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method](https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method) for the full list of supported options.
 
@@ -536,7 +534,6 @@ SitemapGenerator::Sitemap.create do
 end
 ```
 
-
 To generate each one specify the configuration file to run by passing the `CONFIG_FILE` option to `rake sitemap:refresh`, e.g.:
 
 ```
@@ -780,11 +777,21 @@ In /Users/karl/projects/sitemap_generator-test/public/
 Sitemap stats: 3 links / 4 sitemaps / 0m00s
 ```
 
+### Using `create` without a block
+
+You can call `create` without a block, add links (and use `group` as needed), then call `finalize!` on the returned link set when finished.
+
+```ruby
+sitemap = SitemapGenerator::Sitemap.create(default_host: 'http://www.example.com')
+sitemap.add('/home')
+# ... add more links or use groups, then:
+sitemap.finalize!
+```
+
 ### Speeding Things Up
 
 For large ActiveRecord collections with thousands of records it is advisable to iterate through them in batches to avoid loading all records into memory at once.  For this reason in the example above we use `Content.find_each` which is a batched iterator available since Rails 2.3.2, rather than `Content.all`.
 
-
 ## Customizing your Sitemaps
 
 SitemapGenerator supports a number of options which allow you to control every aspect of your sitemap generation.  How they are named, where they are stored, the contents of the links and the location that the sitemaps will be hosted from can all be set.
@@ -1167,16 +1174,15 @@ end
 
 ## Compatibility
 
-Compatible with all versions of Rails and Ruby.  Tested up to Ruby 3.1 and Rails 7.0.
-Ruby 1.9.3 support was dropped in Version 6.0.0.
+Ruby 2.6 through 4.0 and Rails 6.0 through 8.1 are supported.
+Ruby 2.5 and Rails 5.2 were dropped in v7.0.0.
+Ruby 1.9.3 support was dropped in v6.0.0.
 
 ## Licence
 
-Released under the MIT License.  See the (MIT-LICENSE)[MIT-LICENSE] file.
-
-MIT. See the LICENSE.md file.
+Released under the MIT license which is included in the [MIT-LICENSE](./MIT-LICENSE) file.
 
-Copyright (c) Karl Varga released under the MIT license
+Copyright (c) Karl Varga
 
 [canonical_repo]:http://github.com/kjvarga/sitemap_generator
 [sitemap_images]:http://www.google.com/support/webmasters/bin/answer.py?answer=178636

data/VERSION

@@ -1 +1 @@
-6.3.0
+7.0.1

data/lib/sitemap_generator/adapters/active_storage_adapter.rb

@@ -0,0 +1,26 @@
+module SitemapGenerator
+  # Class for uploading sitemaps to ActiveStorage.
+  class ActiveStorageAdapter
+    attr_reader :key, :filename
+
+    def initialize key: :sitemap, filename: 'sitemap.xml.gz'
+      @key, @filename = key, filename
+    end
+
+    def write(location, raw_data)
+      SitemapGenerator::FileAdapter.new.write(location, raw_data)
+
+      ActiveStorage::Blob.transaction do
+        ActiveStorage::Blob.where(key: key).destroy_all
+
+        ActiveStorage::Blob.create_and_upload!(
+          key: key,
+          io: open(location.path, 'rb'),
+          filename: filename,
+          content_type: 'application/gzip',
+          identify: false
+        )
+      end
+    end
+  end
+end

data/lib/sitemap_generator/adapters/aws_sdk_adapter.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 if !defined?(Aws::S3::Resource) or !defined?(Aws::Credentials)
-  raise LoadError, "Error: `Aws::S3::Resource` and/or `Aws::Credentials` are not defined.\n\n"\
+  raise LoadError, "Error: `Aws::S3::Resource` and/or `Aws::Credentials` are not defined.\n\n" \
         "Please `require 'aws-sdk'` - or another library that defines these classes."
 end
 
@@ -27,18 +29,18 @@ module SitemapGenerator
     #   All other options you provide are passed directly to the AWS client.
     #   See https://docs.aws.amazon.com/sdk-for-ruby/v2/api/Aws/S3/Client.html#initialize-instance_method
     #   for a full list of supported options.
-    def initialize(bucket, aws_access_key_id: nil, aws_secret_access_key: nil, aws_region: nil, aws_endpoint: nil, acl: 'public-read', cache_control: 'private, max-age=0, no-cache', **options)
+    def initialize(bucket, aws_access_key_id: nil, aws_secret_access_key: nil, aws_session_token: nil, aws_region: nil, aws_endpoint: nil, acl: 'public-read', cache_control: 'private, max-age=0, no-cache', **options)
       @bucket = bucket
       @acl = acl
       @cache_control = cache_control
       @options = options
       set_option_unless_set(:access_key_id, aws_access_key_id)
       set_option_unless_set(:secret_access_key, aws_secret_access_key)
+      set_option_unless_set(:session_token, aws_session_token)
       set_option_unless_set(:region, aws_region)
       set_option_unless_set(:endpoint, aws_endpoint)
     end
 
-
     # Call with a SitemapLocation and string data
     def write(location, raw_data)
       SitemapGenerator::FileAdapter.new.write(location, raw_data)

data/lib/sitemap_generator/adapters/file_adapter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SitemapGenerator
   # Class for writing out data to a file.
   class FileAdapter

data/lib/sitemap_generator/adapters/fog_adapter.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 if !defined?(Fog::Storage)
-  raise LoadError, "Error: `Fog::Storage` is not defined.\n\n"\
+  raise LoadError, "Error: `Fog::Storage` is not defined.\n\n" \
         "Please `require 'fog'` - or another library that defines this class."
 end
 
@@ -21,11 +23,11 @@ module SitemapGenerator
       SitemapGenerator::FileAdapter.new.write(location, raw_data)
 
       storage   = Fog::Storage.new(@fog_credentials)
-      directory = storage.directories.new(:key => @fog_directory)
+      directory = storage.directories.new(key: @fog_directory)
       directory.files.create(
-        :key    => location.path_in_public,
-        :body   => File.open(location.path),
-        :public => true
+        key: location.path_in_public,
+        body: File.open(location.path),
+        public: true
       )
     end
   end

data/lib/sitemap_generator/adapters/google_storage_adapter.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 if !defined?(Google::Cloud::Storage)
-  raise LoadError, "Error: `Google::Cloud::Storage` is not defined.\n\n"\
+  raise LoadError, "Error: `Google::Cloud::Storage` is not defined.\n\n" \
         "Please `require 'google/cloud/storage'` - or another library that defines this class."
 end
 

data/lib/sitemap_generator/adapters/s3_adapter.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 if !defined?(Fog::Storage)
-  raise LoadError, "Error: `Fog::Storage` is not defined.\n\n"\
+  raise LoadError, "Error: `Fog::Storage` is not defined.\n\n" \
         "Please `require 'fog-aws'` - or another library that defines this class."
 end
 
@@ -23,6 +25,7 @@ module SitemapGenerator
     def initialize(opts = {})
       @aws_access_key_id = opts[:aws_access_key_id] || ENV['AWS_ACCESS_KEY_ID']
       @aws_secret_access_key = opts[:aws_secret_access_key] || ENV['AWS_SECRET_ACCESS_KEY']
+      @aws_session_token = opts[:aws_session_token] || ENV['AWS_SESSION_TOKEN']
       @fog_provider = opts[:fog_provider] || ENV['FOG_PROVIDER']
       @fog_directory = opts[:fog_directory] || ENV['FOG_DIRECTORY']
       @fog_region = opts[:fog_region] || ENV['FOG_REGION']
@@ -36,11 +39,12 @@ module SitemapGenerator
     def write(location, raw_data)
       SitemapGenerator::FileAdapter.new.write(location, raw_data)
 
-      credentials = { :provider => @fog_provider }
+      credentials = { provider: @fog_provider }
 
       if @aws_access_key_id && @aws_secret_access_key
         credentials[:aws_access_key_id] = @aws_access_key_id
         credentials[:aws_secret_access_key] = @aws_secret_access_key
+        credentials[:aws_session_token] = @aws_session_token if @aws_session_token
       else
         credentials[:use_iam_profile] = true
       end
@@ -49,11 +53,11 @@ module SitemapGenerator
       credentials[:path_style] = @fog_path_style if @fog_path_style
 
       storage   = Fog::Storage.new(@fog_storage_options.merge(credentials))
-      directory = storage.directories.new(:key => @fog_directory)
+      directory = storage.directories.new(key: @fog_directory)
       directory.files.create(
-        :key    => location.path_in_public,
-        :body   => File.open(location.path),
-        :public => @fog_public
+        key: location.path_in_public,
+        body: File.open(location.path),
+        public: @fog_public
       )
     end
   end

data/lib/sitemap_generator/adapters/wave_adapter.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 if !defined?(::CarrierWave::Uploader::Base)
-  raise LoadError, "Error: `CarrierWave::Uploader::Base` is not defined.\n\n"\
+  raise LoadError, "Error: `CarrierWave::Uploader::Base` is not defined.\n\n" \
         "Please `require 'carrierwave'` - or another library that defines this class."
 end
 

data/lib/sitemap_generator/application.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'pathname'
 
 module SitemapGenerator
@@ -29,6 +31,7 @@ module SitemapGenerator
     def rails_root
       return ::Rails.root.to_s if defined?(::Rails.root) && ::Rails.root
       return RAILS_ROOT.to_s if defined?(RAILS_ROOT)
+
       nil
     end
 
@@ -40,6 +43,7 @@ module SitemapGenerator
     def rails_env
       return ::Rails.env.to_s if defined?(::Rails.env)
       return RAILS_ENV.to_s if defined?(RAILS_ENV)
+
       nil
     end
   end

data/lib/sitemap_generator/builder/sitemap_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zlib'
 require 'fileutils'
 require 'sitemap_generator/helpers/number_helper'
@@ -20,12 +22,12 @@ module SitemapGenerator
       # * <tt>location</tt> - a SitemapGenerator::SitemapLocation instance or a Hash of options
       #   from which a SitemapLocation will be created for you.  See `SitemapGenerator::SitemapLocation` for
       #   the supported list of options.
-      def initialize(opts={})
+      def initialize(opts = {})
         @location = opts.is_a?(Hash) ? SitemapGenerator::SitemapLocation.new(opts) : opts
         @link_count = 0
         @news_count = 0
-        @xml_content = '' # XML urlset content
-        @xml_wrapper_start = <<-HTML
+        @xml_content = +'' # XML urlset content
+        @xml_wrapper_start = +<<-HTML
           <?xml version="1.0" encoding="UTF-8"?>
             <urlset
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -41,7 +43,7 @@ module SitemapGenerator
             >
         HTML
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!
-        @xml_wrapper_end   = %q[</urlset>]
+        @xml_wrapper_end = '</urlset>'
         @filesize = SitemapGenerator::Utilities.bytesize(@xml_wrapper_start) + SitemapGenerator::Utilities.bytesize(@xml_wrapper_end)
         @written = false
         @reserved_name = nil # holds the name reserved from the namer
@@ -89,15 +91,16 @@ module SitemapGenerator
       #
       # The link added to the sitemap will use the host from its location object
       # if no host has been specified.
-      def add(link, options={})
+      def add(link, options = {})
         raise SitemapGenerator::SitemapFinalizedError if finalized?
 
-        sitemap_url = if link.is_a?(SitemapUrl)
-          link
-        else
-          options[:host] ||= @location.host
-          SitemapUrl.new(link, options)
-        end
+        sitemap_url =
+          if link.is_a?(SitemapUrl)
+            link
+          else
+            options[:host] ||= @location.host
+            SitemapUrl.new(link, options)
+          end
 
         xml = sitemap_url.to_xml
         raise SitemapGenerator::SitemapFullError if !file_can_fit?(xml)
@@ -118,6 +121,7 @@ module SitemapGenerator
       # has already been finalized.
       def finalize!
         raise SitemapGenerator::SitemapFinalizedError if finalized?
+
         @frozen = true
       end
 
@@ -133,7 +137,8 @@ module SitemapGenerator
       # A SitemapGenerator::SitemapError exception is raised if the file has
       # already been written.
       def write
-        raise SitemapGenerator::SitemapError.new("Sitemap already written!") if written?
+        raise SitemapGenerator::SitemapError.new('Sitemap already written!') if written?
+
         finalize! unless finalized?
         reserve_name
         @location.write(@xml_wrapper_start + @xml_content + @xml_wrapper_end, link_count)

data/lib/sitemap_generator/builder/sitemap_index_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SitemapGenerator
   module Builder
     class SitemapIndexFile < SitemapFile
@@ -6,12 +8,12 @@ module SitemapGenerator
       #
       # * <tt>location</tt> - a SitemapGenerator::SitemapIndexLocation instance or a Hash of options
       #   from which a SitemapLocation will be created for you.
-      def initialize(opts={})
+      def initialize(opts = {})
         @location = opts.is_a?(Hash) ? SitemapGenerator::SitemapIndexLocation.new(opts) : opts
         @link_count = 0
         @sitemaps_link_count = 0
-        @xml_content = '' # XML urlset content
-        @xml_wrapper_start = <<-HTML
+        @xml_content = +'' # XML urlset content
+        @xml_wrapper_start = +<<-HTML
           <?xml version="1.0" encoding="UTF-8"?>
             <sitemapindex
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -21,7 +23,7 @@ module SitemapGenerator
             >
         HTML
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!
-        @xml_wrapper_end   = %q[</sitemapindex>]
+        @xml_wrapper_end = '</sitemapindex>'
         @filesize = SitemapGenerator::Utilities.bytesize(@xml_wrapper_start) + SitemapGenerator::Utilities.bytesize(@xml_wrapper_end)
         @written = false
         @reserved_name = nil # holds the name reserved from the namer
@@ -45,7 +47,7 @@ module SitemapGenerator
       # can assume that the index is required (unless create_index is false of course).
       # This seems like the logical thing to do.
       alias_method :super_add, :add
-      def add(link, options={})
+      def add(link, options = {})
         if file = link.is_a?(SitemapFile) && link
           @sitemaps_link_count += file.link_count
           file.finalize! unless file.finalized?
@@ -59,7 +61,7 @@ module SitemapGenerator
           # for there to be an index.
           if @link_count == 0
             @first_sitemap = SitemapGenerator::Builder::LinkHolder.new(file, options)
-            @link_count += 1     # pretend it's added, but don't add it yet
+            @link_count += 1 # pretend it's added, but don't add it yet
           else
             # need an index so make sure name is reserved and first sitemap is written out
             reserve_name unless @location.create_index == false
@@ -94,13 +96,14 @@ module SitemapGenerator
         @sitemaps_link_count
       end
 
-      def stats_summary(opts={})
+      def stats_summary(opts = {})
         str = "Sitemap stats: #{number_with_delimiter(@sitemaps_link_count)} links / #{@link_count} sitemaps"
-        str += " / %dm%02ds" % opts[:time_taken].divmod(60) if opts[:time_taken]
+        str += ' / %dm%02ds' % opts[:time_taken].divmod(60) if opts[:time_taken]
       end
 
       def finalize!
         raise SitemapGenerator::SitemapFinalizedError if finalized?
+
         reserve_name if create_index?
         write_first_sitemap
         @frozen = true
@@ -138,7 +141,7 @@ module SitemapGenerator
         if @first_sitemap
           @first_sitemap.link.write unless @first_sitemap.link.written?
           super_add(SitemapGenerator::Builder::SitemapIndexUrl.new(@first_sitemap.link, @first_sitemap.options))
-          @link_count -= 1   # we already counted it, don't count it twice
+          @link_count -= 1 # we already counted it, don't count it twice
           # Store the URL because if create_index is false, this is the
           # "index" URL
           @first_sitemap_url = @first_sitemap.link.location.url

data/lib/sitemap_generator/builder/sitemap_index_url.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'builder'
 
 module SitemapGenerator
   module Builder
     class SitemapIndexUrl < SitemapUrl
 
-      def initialize(path, options={})
+      def initialize(path, options = {})
         if index = path.is_a?(SitemapGenerator::Builder::SitemapIndexFile) && path
-          options = SitemapGenerator::Utilities.reverse_merge(options, :host => index.location.host, :lastmod => Time.now, :priority => 1.0)
+          options = SitemapGenerator::Utilities.reverse_merge(options, host: index.location.host, lastmod: Time.now, priority: 1.0)
           path = index.location.path_in_public
           super(path, options)
         else
@@ -15,11 +17,11 @@ module SitemapGenerator
       end
 
       # Return the URL as XML
-      def to_xml(builder=nil)
+      def to_xml(builder = nil)
         builder = ::Builder::XmlMarkup.new if builder.nil?
         builder.sitemap do
           builder.loc        self[:loc]
-          builder.lastmod    w3c_date(self[:lastmod])   if self[:lastmod]
+          builder.lastmod    w3c_date(self[:lastmod]) if self[:lastmod]
         end
         builder << '' # force to string
       end