sitemap_generator 6.3.0 → 7.1.1

data/lib/sitemap_generator/tasks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # require this file to load the tasks
 require 'rake'
 
@@ -8,46 +10,34 @@ namespace :sitemap do
   # Require sitemap_generator only.  When installed as a plugin the require will fail, so in
   # that case, load the environment first.
   task :require do
-    begin
-      require 'sitemap_generator'
-    rescue LoadError => e
-      if defined?(Rails::VERSION)
-        Rake::Task['sitemap:require_environment'].invoke
-      else
-        raise e
-      end
-    end
-  end
-
-  # Require sitemap_generator after loading the Rails environment.  We still need the require
-  # in case we are installed as a gem and are setup to not automatically be required.
-  task :require_environment do
-    if defined?(Rails::VERSION)
-      Rake::Task['environment'].invoke
-    end
     require 'sitemap_generator'
   end
+  # In a Rails app, we need to boot Rails.
+  # Ensure gem is required in case it wasn't automatically loaded.
+  Rake::Task[:require].enhance([:environment]) if defined?(Rails)
 
-  desc "Install a default config/sitemap.rb file"
-  task :install => ['sitemap:require'] do
+  desc 'Install a default config/sitemap.rb file'
+  task install: :require do
+    # Uses Rake's verbose flag intentionally — this is a file installation utility
+    # where Rake's -v/--verbose flag is the appropriate control mechanism.
     SitemapGenerator::Utilities.install_sitemap_rb(verbose)
   end
 
-  desc "Delete all Sitemap files in public/ directory"
-  task :clean => ['sitemap:require'] do
+  desc 'Delete all Sitemap files in public/ directory'
+  task clean: :require do
     SitemapGenerator::Utilities.clean_files
   end
 
-  desc "Generate sitemaps and ping search engines."
-  task :refresh => ['sitemap:create'] do
+  desc 'Generate sitemaps and ping search engines.'
+  task refresh: :create do
     SitemapGenerator::Sitemap.ping_search_engines
   end
 
   desc "Generate sitemaps but don't ping search engines."
-  task 'refresh:no_ping' => ['sitemap:create']
+  task 'refresh:no_ping' => :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)
+  task create: :require do
+    SitemapGenerator::Interpreter.run(config_file: ENV.fetch('CONFIG_FILE', nil))
   end
 end

data/lib/sitemap_generator/templates.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SitemapGenerator
   # Provide convenient access to template files.  E.g.
   #
@@ -7,17 +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_accessor(*FILES.keys)
-    FILES.keys.each do |name|
-      eval <<-END
-        define_method(:#{name}) do
-          @#{name} ||= read_template(:#{name})
-        end
-      END
+    attr_writer(*FILES.keys)
+
+    FILES.each_key do |name|
+      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,29 +1,39 @@
+# 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')
-        puts "already exists: config/sitemap.rb, file not copied" if verbose
+    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')
-        puts "created: config/sitemap.rb" if verbose
+          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'])
+      location = SitemapGenerator::Sitemap.sitemap_location
+      dir = location.directory
+      base = SitemapGenerator::Sitemap.filename.to_s
+      return if base.empty?
+
+      FileUtils.rm(Dir[File.join(dir, "#{base}*.xml.gz"), File.join(dir, "#{base}*.xml")])
     end
 
     # Validate all keys in a hash match *valid keys, raising ArgumentError on a
@@ -31,7 +41,7 @@ module SitemapGenerator
     # strings for keys but assert symbols as keys, this will fail.
     def assert_valid_keys(hash, *valid_keys)
       unknown_keys = hash.keys - [valid_keys].flatten
-      raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(", ")}") unless unknown_keys.empty?
+      raise(ArgumentError, "Unknown key(s): #{unknown_keys.join(', ')}") unless unknown_keys.empty?
     end
 
     # Return a new hash with all keys converted to symbols, as long as
@@ -44,7 +54,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
@@ -69,7 +83,7 @@ module SitemapGenerator
     #   x.round(2) # => 1.34
     def round(float, precision = nil)
       if precision
-        magnitude = 10.0 ** precision
+        magnitude = 10.0**precision
         (float * magnitude).round / magnitude
       else
         float.round
@@ -95,10 +109,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.
@@ -111,7 +125,7 @@ module SitemapGenerator
     # ...to:
     #
     #   if !address.blank?
-    def blank?(object)
+    def blank?(object) # rubocop:disable Metrics/MethodLength
       case object
       when NilClass, FalseClass
         true
@@ -133,15 +147,17 @@ 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
+      old_verbose = $VERBOSE
+      $VERBOSE = flag
       yield
     ensure
       $VERBOSE = old_verbose
     end
 
     def titleize(string)
-      string.gsub!(/_/, ' ')
-      string.split(/(\W)/).map(&:capitalize).join
+      result = string.tr('_', ' ')
+      result.gsub!(/\b\w/, &:upcase)
+      result
     end
 
     def truthy?(value)
@@ -156,8 +172,8 @@ module SitemapGenerator
     # Returns a string.  Expects a string or Pathname object.
     def append_slash(path)
       strpath = path.to_s
-      if strpath[-1] != nil && strpath[-1].chr != '/'
-        strpath + '/'
+      if !strpath[-1].nil? && strpath[-1].chr != '/'
+        "#{strpath}/"
       else
         strpath
       end
@@ -167,12 +183,18 @@ 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
     end
 
+    # Return the current time, using Time.zone if available (Rails), otherwise Time.now.
+    def current_time
+      zone = defined?(Time.zone) && Time.zone
+      zone ? zone.now : Time.now
+    end
+
     # Return the bytesize length of the string.  Ruby 1.8.6 compatible.
     def bytesize(string)
       string.respond_to?(:bytesize) ? string.bytesize : string.length

data/lib/sitemap_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sitemap_generator/simple_namer'
 require 'sitemap_generator/builder'
 require 'sitemap_generator/link_set'
@@ -6,9 +8,12 @@ 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')
+  autoload(:ActiveStorageAdapter,     'sitemap_generator/adapters/active_storage_adapter') if defined?(::ActiveStorage)
   autoload(:S3Adapter,                'sitemap_generator/adapters/s3_adapter')
   autoload(:AwsSdkAdapter,            'sitemap_generator/adapters/aws_sdk_adapter')
   autoload(:WaveAdapter,              'sitemap_generator/adapters/wave_adapter')
@@ -17,40 +22,50 @@ 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
 
-  Utilities.with_warnings(nil) do
-    VERSION = File.read(File.dirname(__FILE__) + "/../VERSION").strip
+  class SitemapFinalizedError < SitemapError
+  end
+
+  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 = (Class.new do
-      def method_missing(*args, &block)
-        (@link_set ||= reset!).send(*args, &block)
+    Sitemap = (Config = Class.new do
+      # Use a new LinkSet instance
+      def reset!
+        @link_set = LinkSet.new
       end
 
-      def respond_to?(name, include_private = false)
-        (@link_set ||= reset!).respond_to?(name, include_private)
+      private
+
+      def method_missing(name, *args, &block)
+        @link_set ||= reset!
+        @link_set.respond_to?(name, true) ? @link_set.__send__(name, *args, &block) : super
       end
 
-      # Use a new LinkSet instance
-      def reset!
-        @link_set = LinkSet.new
+      def respond_to_missing?(name, include_private = false)
+        (@link_set ||= reset!).respond_to?(name, include_private) || super
       end
     end).new
+    # rubocop:enable Lint/ConstantDefinitionInBlock
   end
 
   class << self
@@ -62,13 +77,12 @@ module SitemapGenerator
   # Global default for the verbose setting.
   def self.verbose
     if @verbose.nil?
-      @verbose = if SitemapGenerator::Utilities.truthy?(ENV['VERBOSE'])
-        true
-      elsif SitemapGenerator::Utilities.falsy?(ENV['VERBOSE'])
-        false
-      else
-        nil
-      end
+      @verbose =
+        if SitemapGenerator::Utilities.truthy?(ENV['VERBOSE'])
+          true
+        elsif SitemapGenerator::Utilities.falsy?(ENV['VERBOSE'])
+          false
+        end
     else
       @verbose
     end
@@ -79,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

data/rails/uninstall.rb

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

data/templates/sitemap.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 # Set the host name for URL creation
-SitemapGenerator::Sitemap.default_host = "http://www.example.com"
+SitemapGenerator::Sitemap.default_host = 'http://www.example.com'
 
 SitemapGenerator::Sitemap.create do
   # Put links creation logic here.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 7.1.1
 platform: ruby
 authors:
 - Karl Varga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-09 00:00:00.000000000 Z
+date: 2026-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -24,132 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: aws-sdk-core
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: aws-sdk-s3
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: fog-aws
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: google-cloud-storage
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: SitemapGenerator is a framework-agnostic XML Sitemap generator written
   in Ruby with automatic Rails integration.  It supports Video, News, Image, Mobile,
   PageMap and Alternate Links sitemap extensions and includes Rake tasks for managing
@@ -166,6 +40,7 @@ files:
 - lib/capistrano/sitemap_generator.rb
 - lib/capistrano/tasks/sitemap_generator.cap
 - lib/sitemap_generator.rb
+- lib/sitemap_generator/adapters/active_storage_adapter.rb
 - lib/sitemap_generator/adapters/aws_sdk_adapter.rb
 - lib/sitemap_generator/adapters/file_adapter.rb
 - lib/sitemap_generator/adapters/fog_adapter.rb
@@ -197,7 +72,8 @@ files:
 homepage: https://github.com/kjvarga/sitemap_generator
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -206,14 +82,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Easily generate XML Sitemaps