sitemap_generator 7.0.3 → 7.1.0

data/lib/sitemap_generator/link_set.rb

@@ -5,9 +5,12 @@ require 'builder'
 # A LinkSet provisions a bunch of links to sitemap files.  It also writes the index file
 # which lists all the sitemap files written.
 module SitemapGenerator
-  class LinkSet
-    @@requires_finalization_opts = %i[filename sitemaps_path sitemaps_host namer]
-    @@new_location_opts = %i[filename sitemaps_path namer]
+  # Top-level configuration and orchestration object for a sitemap generation run.
+  # Owns the adapter, host, paths, and namer; manages the lifecycle of sitemap files
+  # from creation through finalization. See +SitemapGenerator::Sitemap+ for the public API.
+  class LinkSet # rubocop:disable Metrics/ClassLength
+    REQUIRES_FINALIZATION_OPTS = %i[filename sitemaps_path sitemaps_host namer].freeze
+    NEW_LOCATION_OPTS = %i[filename sitemaps_path namer].freeze
 
     attr_reader :default_host, :sitemaps_path, :filename, :create_index
     attr_accessor :include_root, :include_index, :adapter, :yield_sitemap, :max_sitemap_links
@@ -119,25 +122,26 @@ module SitemapGenerator
     #
     # Note: When adding a new option be sure to include it in `options_for_group()` if
     # the option should be inherited by groups.
-    def initialize(options = {})
-      @default_host, @sitemaps_host, @yield_sitemap, @sitemaps_path, @adapter, @verbose, @protect_index, @sitemap_index, @added_default_links, @created_group, @sitemap = nil
+    def initialize(options = {}) # rubocop:disable Metrics/MethodLength
+      @default_host, @sitemaps_host, @yield_sitemap, @sitemaps_path,
+      @adapter, @verbose, @protect_index, @sitemap_index,
+      @added_default_links, @created_group, @sitemap = nil
 
       options = SitemapGenerator::Utilities.reverse_merge(options,
-        include_root: true,
-        include_index: false,
-        filename: :sitemap,
-        search_engines: {},
-        create_index: :auto,
-        compress: true,
-        max_sitemap_links: SitemapGenerator::MAX_SITEMAP_LINKS
-      )
+                                                          include_root: true,
+                                                          include_index: false,
+                                                          filename: :sitemap,
+                                                          search_engines: {},
+                                                          create_index: :auto,
+                                                          compress: true,
+                                                          max_sitemap_links: SitemapGenerator::MAX_SITEMAP_LINKS)
       options.each_pair { |k, v| instance_variable_set(:"@#{k}", v) }
 
       # If an index is passed in, protect it from modification.
       # Sitemaps can be added to the index but nothing else can be changed.
-      if options[:sitemap_index]
-        @protect_index = true
-      end
+      return unless options[:sitemap_index]
+
+      @protect_index = true
     end
 
     # Add a link to a Sitemap.  If a new Sitemap is required, one will be created for
@@ -198,11 +202,11 @@ module SitemapGenerator
       @created_group = true
       original_opts = opts.dup
 
-      if (@@requires_finalization_opts & original_opts.keys).empty?
+      if (REQUIRES_FINALIZATION_OPTS & original_opts.keys).empty?
         # If no new filename or path is specified reuse the default sitemap file.
         # A new location object will be set on it for the duration of the group.
         original_opts[:sitemap] = sitemap
-      elsif original_opts.key?(:sitemaps_host) && (@@new_location_opts & original_opts.keys).empty?
+      elsif original_opts.key?(:sitemaps_host) && (NEW_LOCATION_OPTS & original_opts.keys).empty?
         # If no location options are provided we are creating the next sitemap in the
         # current series, so finalize and inherit the namer.
         finalize_sitemap!
@@ -294,14 +298,10 @@ module SitemapGenerator
         name = Utilities.titleize(engine.to_s)
         begin
           Timeout.timeout(10) do
-            if URI.respond_to?(:open) # Available since Ruby 2.5
-              URI.open(link)
-            else
-              open(link) # using Kernel#open became deprecated since Ruby 2.7. See https://bugs.ruby-lang.org/issues/15893
-            end
+            URI.open(link) # rubocop:disable Security/Open
           end
           output("  Successful ping of #{name}")
-        rescue Timeout::Error, StandardError => e
+        rescue StandardError => e
           output("Ping failed for #{name}: #{e.inspect} (URL #{link})")
         end
       end
@@ -366,9 +366,7 @@ module SitemapGenerator
     # By default verbose is true.  When running rake tasks, pass the <tt>-s</tt>
     # option to rake to turn verbose off.
     def verbose
-      if @verbose.nil?
-        @verbose = SitemapGenerator.verbose.nil? ? true : SitemapGenerator.verbose
-      end
+      @verbose = SitemapGenerator.verbose.nil? || SitemapGenerator.verbose if @verbose.nil?
       @verbose
     end
 
@@ -401,10 +399,9 @@ module SitemapGenerator
     # change the public path.
     def options_for_group(opts) # rubocop:disable Metrics/MethodLength
       opts = SitemapGenerator::Utilities.reverse_merge(opts,
-        include_index: false,
-        include_root: false,
-        sitemap_index: sitemap_index
-      )
+                                                       include_index: false,
+                                                       include_root: false,
+                                                       sitemap_index: sitemap_index)
       opts.delete(:public_path)
 
       # Reverse merge the current settings.
@@ -412,22 +409,21 @@ module SitemapGenerator
       # This hash could be a problem because it needs to be maintained
       # when new options are added, but can easily be missed.  We really could
       # do with a separate SitemapOptions class.
-      current_settings = [
-        :include_root,
-        :include_index,
-        :sitemaps_path,
-        :public_path,
-        :sitemaps_host,
-        :verbose,
-        :default_host,
-        :adapter,
-        :create_index,
-        :compress,
-        :max_sitemap_links
-      ].inject({}) do |hash, key|
+      current_settings = %i[
+        include_root
+        include_index
+        sitemaps_path
+        public_path
+        sitemaps_host
+        verbose
+        default_host
+        adapter
+        create_index
+        compress
+        max_sitemap_links
+      ].each_with_object({}) do |key, hash|
         value = instance_variable_get(:"@#{key}")
         hash[key] = value unless value.nil?
-        hash
       end
       SitemapGenerator::Utilities.reverse_merge!(opts, current_settings)
       opts
@@ -438,12 +434,10 @@ module SitemapGenerator
     def add_default_links
       @added_default_links = true
       link_options = { lastmod: Time.now, priority: 1.0 }
-      if include_root?
-        add('/', link_options)
-      end
-      if include_index?
-        add(sitemap_index, link_options)
-      end
+      add('/', link_options) if include_root?
+      return unless include_index?
+
+      add(sitemap_index, link_options)
     end
 
     # Finalize a sitemap by including it in the index and outputting a summary line.
@@ -485,9 +479,9 @@ module SitemapGenerator
     # Reset this instance.  Keep the same options, but return to the same state
     # as before any sitemaps were created.
     def reset!
-      @sitemap_index = nil if @sitemap_index && @sitemap_index.finalized? && !@protect_index
-      @sitemap = nil if @sitemap && @sitemap.finalized?
-      self.namer.reset
+      @sitemap_index = nil if @sitemap_index&.finalized? && !@protect_index
+      @sitemap = nil if @sitemap&.finalized?
+      namer.reset
       @added_default_links = false
     end
 
@@ -499,9 +493,9 @@ module SitemapGenerator
       puts string
     end
 
+    # Setters that propagate location configuration (host, paths, adapter) to the
+    # active sitemap and index files whenever a value changes on the LinkSet.
     module LocationHelpers
-      public
-
       # Set the host name, including protocol, that will be used by default on each
       # of your sitemap links.  You can pass a different host in your options to `add`
       # if you need to change it on a per-link basis.
@@ -519,16 +513,14 @@ module SitemapGenerator
       # Set to nil to use the current directory.
       def public_path=(value)
         @public_path = Pathname.new(SitemapGenerator::Utilities.append_slash(value))
-        if @public_path.relative?
-          @public_path = SitemapGenerator.app.root + @public_path
-        end
+        @public_path = SitemapGenerator.app.root + @public_path if @public_path.relative?
         update_location_info(:public_path, @public_path)
-        @public_path
+        @public_path # rubocop:disable Lint/Void -- return value used by send(:public_path=) in the getter
       end
 
       # Return a Pathname with the full path to the public directory
       def public_path
-        @public_path ||= self.send(:public_path=, 'public/')
+        @public_path ||= send(:public_path=, 'public/')
       end
 
       # Set the sitemaps_path.  This path gives the location to write sitemaps to
@@ -612,12 +604,15 @@ module SitemapGenerator
       # are in your sitemap.  If `false` an index file is never created.
       # If `:auto` an index file is created only if your sitemap has more than
       # one sitemap file.
-      def create_index=(value, force = false)
+      def create_index=(value, force = false) # rubocop:disable Style/OptionalBooleanParameter
         @create_index = value
         # Allow overriding the protected status of the index when we are creating a group.
         # Because sometimes we need to force an index in that case.  But generally we don't
         # want to allow people to mess with this value if the index is protected.
-        @sitemap_index.location[:create_index] = value if @sitemap_index && ((!@sitemap_index.finalized? && !@protect_index) || force)
+        return unless @sitemap_index && ((!@sitemap_index.finalized? && !@protect_index) || force)
+
+        @sitemap_index.location[:create_index] =
+          value
       end
 
       # Set the namer to use to generate the sitemap (and index) file names.
@@ -632,7 +627,7 @@ module SitemapGenerator
       # the current sitemap and if there is no sitemap, creates a new one using
       # the current filename.
       def namer
-        @namer ||= @sitemap && @sitemap.location.namer || SitemapGenerator::SimpleNamer.new(@filename)
+        @namer ||= @sitemap&.location&.namer || SitemapGenerator::SimpleNamer.new(@filename)
       end
 
       # Set the value of the compress setting.
@@ -663,7 +658,10 @@ module SitemapGenerator
       # But don't create the index or sitemap files yet if they are not already created.
       def update_location_info(attribute, value, opts = {})
         opts = SitemapGenerator::Utilities.reverse_merge(opts, include_index: !@protect_index)
-        @sitemap_index.location[attribute] = value if opts[:include_index] && @sitemap_index && !@sitemap_index.finalized?
+        if opts[:include_index] && @sitemap_index && !@sitemap_index.finalized?
+          @sitemap_index.location[attribute] =
+            value
+        end
         @sitemap.location[attribute] = value if @sitemap && !@sitemap.finalized?
       end
     end

data/lib/sitemap_generator/railtie.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module SitemapGenerator
+  # Loads sitemap_generator rake tasks automatically when the gem is used in a Rails app.
   class Railtie < Rails::Railtie
     rake_tasks do
       load 'tasks/sitemap_generator_tasks.rake'

data/lib/sitemap_generator/simple_namer.rb

@@ -30,10 +30,9 @@ module SitemapGenerator
   class SimpleNamer
     def initialize(base, options = {})
       @options = SitemapGenerator::Utilities.reverse_merge(options,
-        zero: nil, # identifies the marker for the start of the series
-        extension: '.xml.gz',
-        start: 1
-      )
+                                                           zero: nil, # marker for the start of the series
+                                                           extension: '.xml.gz',
+                                                           start: 1)
       @base = base
       reset
     end

data/lib/sitemap_generator/sitemap_location.rb

@@ -6,12 +6,12 @@ module SitemapGenerator
   # A class for determining the exact location at which to write sitemap data.
   # Handles reserving filenames from namers, constructing paths and sending
   # data to the adapter to be written out.
-  class SitemapLocation < Hash
+  class SitemapLocation < Hash # rubocop:disable Metrics/ClassLength
     include SitemapGenerator::Helpers::NumberHelper
 
     PATH_OUTPUT_WIDTH = 47 # Character width of the path in the summary lines
 
-    [:host, :adapter].each do |method|
+    %i[host adapter].each do |method|
       define_method(method) do
         raise SitemapGenerator::SitemapError, "No value set for #{method}" unless self[method]
 
@@ -19,7 +19,7 @@ module SitemapGenerator
       end
     end
 
-    [:public_path, :sitemaps_path].each do |method|
+    %i[public_path sitemaps_path].each do |method|
       define_method(method) do
         Pathname.new(SitemapGenerator::Utilities.append_slash(self[method]))
       end
@@ -48,36 +48,35 @@ module SitemapGenerator
     #   stripped from the filename.  If `:all_but_first`, only the `.gz` extension of the first
     #   filename is stripped off.  If `true` the extensions are left unchanged.
     # * <tt>max_sitemap_links</tt> - The maximum number of links to put in each sitemap.
-    def initialize(opts = {})
-      SitemapGenerator::Utilities.assert_valid_keys(opts, [
-        :adapter,
-        :public_path,
-        :sitemaps_path,
-        :host,
-        :filename,
-        :namer,
-        :verbose,
-        :create_index,
-        :compress,
-        :max_sitemap_links
-      ])
+    def initialize(opts = {}) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      super()
+      SitemapGenerator::Utilities.assert_valid_keys(opts, %i[
+                                                      adapter
+                                                      public_path
+                                                      sitemaps_path
+                                                      host
+                                                      filename
+                                                      namer
+                                                      verbose
+                                                      create_index
+                                                      compress
+                                                      max_sitemap_links
+                                                    ])
       opts[:adapter] ||= SitemapGenerator::FileAdapter.new
-      opts[:public_path] ||= SitemapGenerator.app.root + 'public/'
+      opts[:public_path] ||= SitemapGenerator.app.root + 'public/' # rubocop:disable Style/StringConcatenation
       # This is a bit of a hack to make the SimpleNamer act like the old SitemapNamer.
       # It doesn't really make sense to create a default namer like this because the
       # namer instance should be shared by the location objects of the sitemaps and
       # sitemap index files.  However, this greatly eases testing, so I'm leaving it in
       # for now.
-      if !opts[:filename] && !opts[:namer]
-        opts[:namer] = SitemapGenerator::SimpleNamer.new(:sitemap, start: 2, zero: 1)
-      end
-      opts[:verbose] = !!opts[:verbose]
-      self.merge!(opts)
+      opts[:namer] = SitemapGenerator::SimpleNamer.new(:sitemap, start: 2, zero: 1) if !opts[:filename] && !opts[:namer]
+      opts[:verbose] = !!opts[:verbose] # rubocop:disable Style/DoubleNegation
+      merge!(opts)
     end
 
     # Return a new Location instance with the given options merged in
     def with(opts = {})
-      self.merge(opts)
+      merge(opts)
     end
 
     # Full path to the directory of the file.
@@ -101,18 +100,26 @@ module SitemapGenerator
     end
 
     # Return the size of the file at <tt>path</tt>
-    def filesize
+    def filesize # rubocop:disable Naming/PredicateMethod
       File.size?(path)
     end
 
+    def gzip?
+      /\.gz$/.match?(filename.to_s)
+    end
+
+    def content_type
+      gzip? ? 'application/x-gzip' : 'application/xml'
+    end
+
     # Return the filename.  Raises an exception if no filename or namer is set.
     # If using a namer once the filename has been retrieved from the namer its
     # value is locked so that it is unaffected by further changes to the namer.
-    def filename
+    def filename # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity
       raise SitemapGenerator::SitemapError, 'No filename or namer set' unless self[:filename] || self[:namer]
 
       unless self[:filename]
-        self.send(:[]=, :filename, +self[:namer].to_s, super: true)
+        send(:[]=, :filename, +self[:namer].to_s, super: true)
 
         # Post-process the filename for our compression settings.
         # Strip the `.gz` from the extension if we aren't compressing this file.
@@ -120,7 +127,7 @@ module SitemapGenerator
         # expected.  Ultimately I should force using a namer in all circumstances.
         # Changing the filename here will affect how the FileAdapter writes out the file.
         if self[:compress] == false ||
-           (self[:namer] && self[:namer].start? && self[:compress] == :all_but_first)
+           (self[:namer]&.start? && self[:compress] == :all_but_first)
           self[:filename].gsub!(/\.gz$/, '')
         end
       end
@@ -153,7 +160,7 @@ module SitemapGenerator
 
     # If you set the filename, clear the namer and vice versa.
     def []=(key, value, opts = {})
-      if !opts[:super]
+      unless opts[:super]
         case key
         when :namer
           super(:filename, nil)
@@ -175,17 +182,18 @@ module SitemapGenerator
     def summary(link_count)
       filesize = number_to_human_size(self.filesize)
       width = self.class::PATH_OUTPUT_WIDTH
-      path = SitemapGenerator::Utilities.ellipsis(self.path_in_public, width)
-      "+ #{('%-' + width.to_s + 's') % path} #{'%10s' % link_count} links / #{'%10s' % filesize}"
+      path = SitemapGenerator::Utilities.ellipsis(path_in_public, width)
+      "+ #{format("%-#{width}s", path)} #{format('%10s', link_count)} links / #{format('%10s', filesize)}"
     end
   end
 
+  # SitemapLocation subclass for the sitemap index file.
+  # Defaults the namer to +:sitemap+ (no numeric suffix on the first name) and
+  # exposes the +create_index+ option.
   class SitemapIndexLocation < SitemapLocation
     def initialize(opts = {})
-      if !opts[:filename] && !opts[:namer]
-        opts[:namer] = SitemapGenerator::SimpleNamer.new(:sitemap)
-      end
-      super(opts)
+      opts[:namer] = SitemapGenerator::SimpleNamer.new(:sitemap) if !opts[:filename] && !opts[:namer]
+      super
     end
 
     # Whether to create a sitemap index.  Default `:auto`.  See <tt>LinkSet::create_index=</tt>
@@ -201,8 +209,8 @@ module SitemapGenerator
     def summary(link_count)
       filesize = number_to_human_size(self.filesize)
       width = self.class::PATH_OUTPUT_WIDTH - 3
-      path = SitemapGenerator::Utilities.ellipsis(self.path_in_public, width)
-      "+ #{('%-' + width.to_s + 's') % path} #{'%10s' % link_count} sitemaps / #{'%10s' % filesize}"
+      path = SitemapGenerator::Utilities.ellipsis(path_in_public, width)
+      "+ #{format("%-#{width}s", path)} #{format('%10s', link_count)} sitemaps / #{format('%10s', filesize)}"
     end
   end
 end

data/lib/sitemap_generator/tasks.rb

@@ -36,6 +36,6 @@ namespace :sitemap do
 
   desc "Generate sitemaps but don't ping search engines.  Alias for refresh:no_ping."
   task create: :require do
-    SitemapGenerator::Interpreter.run(config_file: ENV['CONFIG_FILE'], verbose: verbose)
+    SitemapGenerator::Interpreter.run(config_file: ENV.fetch('CONFIG_FILE', nil), verbose: verbose)
   end
 end

data/lib/sitemap_generator/templates.rb

@@ -9,18 +9,17 @@ module SitemapGenerator
   # Define an accessor method for each template file.
   class Templates
     FILES = {
-      sitemap_sample: 'sitemap.rb',
-    }
+      sitemap_sample: 'sitemap.rb'
+    }.freeze
 
     # Dynamically define accessors for each key defined in <tt>FILES</tt>
     attr_writer(*FILES.keys)
 
     FILES.each_key do |name|
-      eval(<<-ACCESSOR, binding, __FILE__, __LINE__ + 1)
-        define_method(:#{name}) do
-          @#{name} ||= read_template(:#{name})
-        end
-      ACCESSOR
+      define_method(name) do
+        ivar = :"@#{name}"
+        instance_variable_get(ivar) || instance_variable_set(ivar, read_template(name))
+      end
     end
 
     def initialize(root = SitemapGenerator.root)

data/lib/sitemap_generator/utilities.rb

@@ -1,31 +1,34 @@
 # frozen_string_literal: true
 
 module SitemapGenerator
-  module Utilities
-    extend self
+  # Internal utility functions: hash merging, string manipulation, byte calculation,
+  # and warning suppression. Not part of the public API.
+  module Utilities # rubocop:disable Metrics/ModuleLength
+    module_function
 
     # Copy templates/sitemap.rb to config if not there yet.
-    def install_sitemap_rb(verbose = false)
-      if File.exist?(SitemapGenerator.app.root + 'config/sitemap.rb')
+    def install_sitemap_rb(verbose = false) # rubocop:disable Style/OptionalBooleanParameter
+      if File.exist?(SitemapGenerator.app.root + 'config/sitemap.rb') # rubocop:disable Style/StringConcatenation
         puts 'already exists: config/sitemap.rb, file not copied' if verbose
       else
         FileUtils.cp(
           SitemapGenerator.templates.template_path(:sitemap_sample),
-          SitemapGenerator.app.root + 'config/sitemap.rb')
+          SitemapGenerator.app.root + 'config/sitemap.rb' # rubocop:disable Style/StringConcatenation
+        )
         puts 'created: config/sitemap.rb' if verbose
       end
     end
 
     # Remove config/sitemap.rb if exists.
     def uninstall_sitemap_rb
-      if File.exist?(SitemapGenerator.app.root + 'config/sitemap.rb')
-        File.rm(SitemapGenerator.app.root + 'config/sitemap.rb')
-      end
+      return unless File.exist?(SitemapGenerator.app.root + 'config/sitemap.rb') # rubocop:disable Style/StringConcatenation
+
+      File.rm(SitemapGenerator.app.root + 'config/sitemap.rb') # rubocop:disable Style/StringConcatenation
     end
 
     # Clean sitemap files in output directory.
     def clean_files
-      FileUtils.rm(Dir[SitemapGenerator.app.root + 'public/sitemap*.xml.gz'])
+      FileUtils.rm(Dir[SitemapGenerator.app.root + 'public/sitemap*.xml.gz']) # rubocop:disable Style/StringConcatenation
     end
 
     # Validate all keys in a hash match *valid keys, raising ArgumentError on a
@@ -46,7 +49,11 @@ module SitemapGenerator
     # to +to_sym+.
     def symbolize_keys!(hash)
       hash.keys.each do |key|
-        hash[(key.to_sym rescue key) || key] = hash.delete(key)
+        hash[begin
+          key.to_sym
+        rescue StandardError
+          key
+        end || key] = hash.delete(key)
       end
       hash
     end
@@ -97,10 +104,10 @@ module SitemapGenerator
       other_hash.merge(hash)
     end
 
-    # Performs the opposite of <tt>merge</tt>, with the keys and values from the first hash taking precedence over the second.
-    # Modifies the receiver in place.
+    # Performs the opposite of <tt>merge</tt>, with the keys and values from the first hash taking
+    # precedence over the second. Modifies the receiver in place.
     def reverse_merge!(hash, other_hash)
-      hash.merge!(other_hash) { |k, o, n| o }
+      hash.merge!(other_hash) { |_k, o, _n| o }
     end
 
     # An object is blank if it's false, empty, or a whitespace string.
@@ -135,7 +142,8 @@ module SitemapGenerator
 
     # Sets $VERBOSE for the duration of the block and back to its original value afterwards.
     def with_warnings(flag)
-      old_verbose, $VERBOSE = $VERBOSE, flag # rubocop:disable Style/ParallelAssignment
+      old_verbose = $VERBOSE
+      $VERBOSE = flag
       yield
     ensure
       $VERBOSE = old_verbose
@@ -143,7 +151,7 @@ module SitemapGenerator
 
     def titleize(string)
       result = string.tr('_', ' ')
-      result.gsub!(/\b\w/) { |match| match.upcase }
+      result.gsub!(/\b\w/, &:upcase)
       result
     end
 
@@ -160,7 +168,7 @@ module SitemapGenerator
     def append_slash(path)
       strpath = path.to_s
       if !strpath[-1].nil? && strpath[-1].chr != '/'
-        strpath + '/'
+        "#{strpath}/"
       else
         strpath
       end
@@ -170,7 +178,7 @@ module SitemapGenerator
     # or bigger than max.
     def ellipsis(string, max)
       if string.size > max
-        (string[0, max - 3] || '') + '...'
+        "#{string[0, max - 3] || ''}..."
       else
         string
       end

data/lib/sitemap_generator.rb

@@ -8,6 +8,8 @@ require 'sitemap_generator/utilities'
 require 'sitemap_generator/application'
 require 'sitemap_generator/sitemap_location'
 
+# Top-level namespace for the gem. +SitemapGenerator::Sitemap+ is the public entry point;
+# adapters, builders, and utilities are nested here.
 module SitemapGenerator
   autoload(:Interpreter,              'sitemap_generator/interpreter')
   autoload(:FileAdapter,              'sitemap_generator/adapters/file_adapter')
@@ -20,24 +22,30 @@ module SitemapGenerator
   autoload(:BigDecimal,               'sitemap_generator/core_ext/big_decimal')
   autoload(:Numeric,                  'sitemap_generator/core_ext/numeric')
 
-  SitemapError          = Class.new(StandardError)
-  SitemapFullError      = Class.new(SitemapError)
-  SitemapFinalizedError = Class.new(SitemapError)
+  class SitemapError < StandardError
+  end
+
+  class SitemapFullError < SitemapError
+  end
+
+  class SitemapFinalizedError < SitemapError
+  end
 
-  Utilities.with_warnings(nil) do
-    VERSION = File.read(File.dirname(__FILE__) + '/../VERSION').strip
+  Utilities.with_warnings(nil) do # rubocop:disable Metrics/BlockLength
+    # rubocop:disable Lint/ConstantDefinitionInBlock
+    VERSION = File.read("#{File.dirname(__FILE__)}/../VERSION").strip
     MAX_SITEMAP_FILES    = 50_000        # max sitemap links per index file
     MAX_SITEMAP_LINKS    = 50_000        # max links per sitemap
     MAX_SITEMAP_IMAGES   = 1_000         # max images per url
     MAX_SITEMAP_NEWS     = 1_000         # max news sitemap per index_file
     MAX_SITEMAP_FILESIZE = 50_000_000    # bytes
     SCHEMAS = {
-      'image'   => 'http://www.google.com/schemas/sitemap-image/1.1',
-      'mobile'  => 'http://www.google.com/schemas/sitemap-mobile/1.0',
-      'news'    => 'http://www.google.com/schemas/sitemap-news/0.9',
+      'image' => 'http://www.google.com/schemas/sitemap-image/1.1',
+      'mobile' => 'http://www.google.com/schemas/sitemap-mobile/1.0',
+      'news' => 'http://www.google.com/schemas/sitemap-news/0.9',
       'pagemap' => 'http://www.google.com/schemas/sitemap-pagemap/1.0',
-      'video'   => 'http://www.google.com/schemas/sitemap-video/1.1'
-    }
+      'video' => 'http://www.google.com/schemas/sitemap-video/1.1'
+    }.freeze
 
     # Lazy-initialize the LinkSet instance
     Sitemap = (Config = Class.new do
@@ -57,6 +65,7 @@ module SitemapGenerator
         (@link_set ||= reset!).respond_to?(name, include_private) || super
       end
     end).new
+    # rubocop:enable Lint/ConstantDefinitionInBlock
   end
 
   class << self
@@ -73,8 +82,6 @@ module SitemapGenerator
           true
         elsif SitemapGenerator::Utilities.falsy?(ENV['VERBOSE'])
           false
-        else
-          nil
         end
     else
       @verbose
@@ -86,8 +93,9 @@ module SitemapGenerator
     !!@yield_sitemap
   end
 
-  self.root      = File.expand_path(File.join(File.dirname(__FILE__), '../')) # Root of the install dir, not the Rails app
-  self.templates = SitemapGenerator::Templates.new(self.root)
+  # Root of the install dir, not the Rails app
+  self.root      = File.expand_path(File.join(File.dirname(__FILE__), '../'))
+  self.templates = SitemapGenerator::Templates.new(root)
   self.app       = SitemapGenerator::Application.new
 end
 

data/lib/tasks/sitemap_generator_tasks.rake

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 load(File.expand_path(File.join(File.dirname(__FILE__), '../sitemap_generator/tasks.rb')))

data/rails/install.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 # Install hook code here
 SitemapGenerator::Utilities.install_sitemap_rb