Skip to content

sitemaps_host handles missing protocol #481

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jasonkarns wants to merge 3 commits into from
Closed

sitemaps_host handles missing protocol #481

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
742f962
sitemaps_host should prefer mailer config
jasonkarns Mar 21, 2026
1118176
Account for nil/empty-string host option
jasonkarns Mar 21, 2026
3a05039
Infer protocol from Rails if asset_host is missing protocol
jasonkarns Mar 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion integration/spec/sitemap_generator/railtie_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,20 @@
end

it "doesn't construct a default_host if missing :host" do
config.action_controller.default_url_options = { trailing_slash: true }
config.action_controller.default_url_options = { host: "", trailing_slash: true }

initializer.run(app)

expect(config.sitemap.default_host).to be_nil
end

it "infers protocol from Rails (respects force_ssl)" do
config.action_controller.default_url_options = { host: "example.test" }

initializer.run(app)

expect(config.sitemap.default_host).to eq "http://example.test"
end
end

describe ".sitemaps_host" do
Expand Down Expand Up @@ -78,6 +86,14 @@

expect(config.sitemap.sitemaps_host).to be_nil
end

it "infers protocol from Rails (respects force_ssl)" do
config.action_controller.asset_host = "example.test"

initializer.run(app)

expect(config.sitemap.sitemaps_host).to eq "http://example.test"
end
end

describe ".compress" do
Expand Down
14 changes: 9 additions & 5 deletions lib/sitemap_generator/railtie.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,14 +17,18 @@ class Railtie < Rails::Railtie
.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)
# respects force_ssl if protocol is missing
config.sitemap.default_host ||= ActionDispatch::Http::URL.full_url_for(url_opts) if url_opts[:host].present?

# 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
asset_opts ||= { host: [
config.try(:action_mailer).try(:asset_host),
config.try(:action_controller).try(:asset_host)
].grep(String).compact_blank.first }

# respects force_ssl if protocol is missing
config.sitemap.sitemaps_host ||= ActionDispatch::Http::URL.full_url_for(asset_opts) if asset_opts[:host].present?

config.sitemap.compress = config.try(:assets).try(:gzip) if config.sitemap.compress.nil?

Expand Down
Loading