sitemap_generator 7.0.1 → 7.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b26cd553fe4ecc452da26ac6aff3262238f065dc12d9f328959eb3c1edc79f6e
-  data.tar.gz: 877828e867880ed215df8b3e1f6acb130e4e8c5856a349e61e6af17a5c641ac9
+  metadata.gz: 64e5f8cba69093d945ae1e54d6c89fb8da86367ce4bb08a55e19e3652da25cc4
+  data.tar.gz: bc7f1dcf2f220d5ed0b8a53062df1411864fecf47fbaf5ed5de3743b099db65c
 SHA512:
-  metadata.gz: d957d69f7a4c2fe8e98cecb84045d58fe59f9f8143764c88695a7561a63d54e9d515c80bdc2b2cf496b1704ffb2ca4610b54f5889cb246e2ed45aac88029abdd
-  data.tar.gz: 884fc7be3809f6670cce09afdddfa64cdf6b4c5b25cdc7ad5c7c3b784d08f83bbc96bdb671a1b52de7f0f59fac8618f1bc83122c01664ee574a52c4edd791699
+  metadata.gz: 10a915440acdf9c713f2ba8f5acf0306f88cf2ed898c5b213b6001dadf674e78e950c62aa54d84db91d7b292ccfac8df22b393f98749ed3af4acb6e78767c32e
+  data.tar.gz: 1a0fa9ad0f5d374f423db19334498054b45d26e17696bb978ce42442ad7bdcf394305396e8a6252681cfe34ac543bcce92e76f1044b55206acbf565991e0015c

data/CHANGES.md

@@ -1,3 +1,7 @@
+### 7.0.2
+
+* Reduce string copies and improve compatibility with `frozen_string_literal`. [#456](https://github.com/kjvarga/sitemap_generator/pull/456)
+
 ### 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)

data/VERSION

@@ -1 +1 @@
-7.0.1
+7.0.2

data/lib/sitemap_generator/adapters/aws_sdk_adapter.rb

@@ -44,12 +44,25 @@ module SitemapGenerator
     # Call with a SitemapLocation and string data
     def write(location, raw_data)
       SitemapGenerator::FileAdapter.new.write(location, raw_data)
-      s3_object = s3_resource.bucket(@bucket).object(location.path_in_public)
-      s3_object.upload_file(location.path, {
-        acl: @acl,
-        cache_control: @cache_control,
-        content_type: location[:compress] ? 'application/x-gzip' : 'application/xml'
-      }.compact)
+
+      if defined?(Aws::S3::TransferManager)
+        client = Aws::S3::Client.new(@options)
+        transfer_manager = Aws::S3::TransferManager.new(client: client)
+        transfer_manager.upload_file(location.path,
+          bucket: @bucket,
+          key: location.path_in_public,
+          acl: @acl,
+          cache_control: @cache_control,
+          content_type: location[:compress] ? 'application/x-gzip' : 'application/xml'
+        )
+      else
+        s3_object = s3_resource.bucket(@bucket).object(location.path_in_public)
+        s3_object.upload_file(location.path, {
+          acl: @acl,
+          cache_control: @cache_control,
+          content_type: location[:compress] ? 'application/x-gzip' : 'application/xml'
+        }.compact)
+      end
     end
 
     private

data/lib/sitemap_generator/builder/sitemap_file.rb

@@ -26,8 +26,7 @@ module SitemapGenerator
         @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_wrapper_start = <<-HTML
           <?xml version="1.0" encoding="UTF-8"?>
             <urlset
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -45,6 +44,7 @@ module SitemapGenerator
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!
         @xml_wrapper_end = '</urlset>'
         @filesize = SitemapGenerator::Utilities.bytesize(@xml_wrapper_start) + SitemapGenerator::Utilities.bytesize(@xml_wrapper_end)
+        @xml_content = @xml_wrapper_start
         @written = false
         @reserved_name = nil # holds the name reserved from the namer
         @frozen = false      # rather than actually freeze, use this boolean
@@ -141,8 +141,9 @@ module SitemapGenerator
 
         finalize! unless finalized?
         reserve_name
-        @location.write(@xml_wrapper_start + @xml_content + @xml_wrapper_end, link_count)
-        @xml_content = @xml_wrapper_start = @xml_wrapper_end = ''
+        @xml_content << @xml_wrapper_end
+        @location.write(@xml_content, link_count)
+        @xml_content = @xml_wrapper_end = ''
         @written = true
       end
 

data/lib/sitemap_generator/builder/sitemap_index_file.rb

@@ -12,7 +12,6 @@ module SitemapGenerator
         @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 version="1.0" encoding="UTF-8"?>
             <sitemapindex
@@ -25,6 +24,7 @@ module SitemapGenerator
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!
         @xml_wrapper_end = '</sitemapindex>'
         @filesize = SitemapGenerator::Utilities.bytesize(@xml_wrapper_start) + SitemapGenerator::Utilities.bytesize(@xml_wrapper_end)
+        @xml_content = @xml_wrapper_start
         @written = false
         @reserved_name = nil # holds the name reserved from the namer
         @frozen = false      # rather than actually freeze, use this boolean

data/lib/sitemap_generator/railtie.rb

@@ -2,8 +2,60 @@
 
 module SitemapGenerator
   class Railtie < Rails::Railtie
+    # Top level options object to namespace all settings
+    config.sitemap = ActiveSupport::OrderedOptions.new
+
     rake_tasks do
       load 'tasks/sitemap_generator_tasks.rake'
     end
+
+    # Recognize existing Rails options as defaults for config.sitemap.*
+    initializer 'sitemap_generator.set_configs' do |app|
+      # routes.default_url_options takes precedence, falling back to configs
+      url_opts = (app.default_url_options || {})
+                 .with_defaults(config.try(:action_controller).try(:default_url_options) || {})
+                 .with_defaults(config.try(:action_mailer).try(:default_url_options) || {})
+                 .with_defaults(config.try(:active_job).try(:default_url_options) || {})
+
+      config.sitemap.default_host ||= ActionDispatch::Http::URL.full_url_for(url_opts) if url_opts.key?(:host)
+
+      # Rails defaults action_controller.asset_host and action_mailer.asset_host
+      # to the top-level config.asset_host so we get that for free here.
+      config.sitemap.sitemaps_host ||= [
+        config.try(:action_controller).try(:asset_host),
+        config.try(:action_mailer).try(:asset_host)
+      ].grep(String).first
+
+      config.sitemap.compress = config.try(:assets).try(:gzip) if config.sitemap.compress.nil?
+
+      config.sitemap.public_path ||= app.paths['public'].first
+
+      # "Compile" config.sitemap options onto the Sitemap class.
+      config.after_initialize do
+        ActiveSupport.on_load(:sitemap_generator, yield: true) do |sitemap|
+          config.sitemap.except(:adapter).each { |k, v| sitemap.public_send("#{k}=", v) }
+        end
+      end
+    end
+
+    # Allow setting the CONFIG_FILE without relying on env var;
+    # (e.g in config/application or environments/*.rb)
+    initializer 'sitemap_generator.config_file' do
+      if (config_file = config.sitemap.delete(:config_file).presence) && ENV['CONFIG_FILE'].blank?
+        ENV['CONFIG_FILE'] = config_file
+      end
+    end
+
+    # Allow lazily setting the adapter class without forcing an autoload.
+    # (ie. string or symbol name; or Callable (proc/lambda/etc))
+    initializer 'sitemap_generator.adapter' do |app|
+      config.to_prepare do
+        ActiveSupport.on_load(:sitemap_generator) do
+          self.adapter = Utilities.find_adapter app.config.sitemap.adapter
+        end
+      end
+    end
   end
+
+  ActiveSupport.run_load_hooks(:sitemap_generator, Sitemap)
 end

data/lib/sitemap_generator/tasks.rb

@@ -10,46 +10,32 @@ 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
+  task install: :require do
     SitemapGenerator::Utilities.install_sitemap_rb(verbose)
   end
 
   desc 'Delete all Sitemap files in public/ directory'
-  task clean: ['sitemap:require'] do
+  task clean: :require do
     SitemapGenerator::Utilities.clean_files
   end
 
   desc 'Generate sitemaps and ping search engines.'
-  task refresh: ['sitemap:create'] do
+  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
+  task create: :require do
     SitemapGenerator::Interpreter.run(config_file: ENV['CONFIG_FILE'], verbose: verbose)
   end
 end

data/lib/sitemap_generator/utilities.rb

@@ -142,9 +142,9 @@ module SitemapGenerator
     end
 
     def titleize(string)
-      string = string.dup if string.frozen?
-      string.gsub!(/_/, ' ')
-      string.split(/(\W)/).map(&:capitalize).join
+      result = string.tr('_', ' ')
+      result.gsub!(/\b\w/) { |match| match.upcase }
+      result
     end
 
     def truthy?(value)
@@ -180,5 +180,29 @@ module SitemapGenerator
     def bytesize(string)
       string.respond_to?(:bytesize) ? string.bytesize : string.length
     end
+
+    # Looks up an adapter from various sources:
+    # 1. symbol/string names are camelized and constantized
+    #   - :fog becomes SitemapGenerator::FogAdapter
+    #   - 'external/adapter_class' becomes External::AdapterClass
+    # 2. classes are instantiated
+    # 3. callables (procs, lambdas, #call) are "called"
+    # All steps recurse, so a proc could return a string that names a class that is instantiated.
+    #
+    # This method is used by the Rails railtie and as such,
+    # safely depends on ActiveSupport::Inflector.
+    def find_adapter(candidate)
+      if candidate.is_a?(Symbol) || candidate.is_a?(String)
+        candidate.to_s.camelize.then { |name|
+          "SitemapGenerator::#{name}Adapter".safe_constantize || name.safe_constantize
+        }.then { |c| find_adapter(c) }
+      elsif candidate.respond_to?(:new)
+        find_adapter candidate.new
+      elsif candidate.respond_to?(:call)
+        find_adapter candidate.call
+      else
+        candidate
+      end
+    end
   end
 end

data/lib/sitemap_generator.rb

@@ -40,18 +40,21 @@ module SitemapGenerator
     }
 
     # 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
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sitemap_generator
 version: !ruby/object:Gem::Version
-  version: 7.0.1
+  version: 7.0.2
 platform: ruby
 authors:
 - Karl Varga
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-28 00:00:00.000000000 Z
+date: 2026-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
@@ -82,7 +82,7 @@ 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:
   - - ">="