indexmap 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 90b723b27367659107827ca3ff1f7473c6a4a917b62ae1cdb4ae2cfcf440f3f2
-  data.tar.gz: cd5be4391a83b1378efcad593408648822dabff4dc8e5479e6ae3e3c12d93ac3
+  metadata.gz: 7e1e66f1d2afc109e4475d63d4c24c4e66d4da6a50e729b1f67f325bf729b792
+  data.tar.gz: ce2d2d9f892c510b337e7c2155cc304044a9182722588172456c82b737e196d3
 SHA512:
-  metadata.gz: '099bf5472fae8a8be3d17ad40003ea5802dd410799431af367e604dca3cd0fce04e98555526dfb36b98f270774b41eec160a47c5abdc9fd81ac148080901d96f'
-  data.tar.gz: e53e45fe051e02b0000e05c5000f8f23c2e1cc7ab78a952cad6a4a33891b108c8811cd67d9fcadea6cf39bea4abf74eae9736d9e85402e6a1988ef49ace9c0dc
+  metadata.gz: 0ad6376f15ef8e5f734c952ae209b472cdefeeb195c641c05e84413f58a3f699f33a8dd6145d661df14c3603fa26268829fae0028da66496bc222f85a3a3c21b
+  data.tar.gz: 2a1c8520caabe2cd2650dda8fd62e77fb9a3a55f85d508b38eb2529d1a658701c15fb65a168e65d278587b55ecbeae15d6bba929b17a1d1855dace51e6d205cd

data/CHANGELOG.md

@@ -5,12 +5,140 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.0] - 2026-07-21
+
+
+### Added
+
+- harden git commit ([#15](https://github.com/ethos-link/indexmap/pull/15))
+
+
+
+
+### Changed
+
+- lazy load search console dependencies ([#16](https://github.com/ethos-link/indexmap/pull/16))
+
+
+
+## [0.7.1] - 2026-05-31
+
+
+### Documentation
+
+- document google search console credentials
+
+
+
+
+### Fixed
+
+- preserve release changelog history ([#13](https://github.com/ethos-link/indexmap/pull/13))
+
+- improve sitemap create output ([#14](https://github.com/ethos-link/indexmap/pull/14))
+
+
+
 ## [0.7.0] - 2026-05-08
 
 
 ### Fixed
 
-- avoid rewriting existing IndexNow key files (#11)
+- avoid rewriting existing IndexNow key files ([#11](https://github.com/ethos-link/indexmap/pull/11))
+
+
+
+## [0.6.0] - 2026-05-01
+
+
+### Added
+
+- add the url count to google ping output ([#9](https://github.com/ethos-link/indexmap/pull/9))
+
+- support named sitemap outputs ([#10](https://github.com/ethos-link/indexmap/pull/10))
+
+
+
+## [0.5.0] - 2026-04-24
+
+
+### Fixed
+
+- namespace rake tasks and harden sitemap validation ([#8](https://github.com/ethos-link/indexmap/pull/8))
+
+
+
+## [0.4.2] - 2026-04-23
+
+
+### Fixed
+
+- harden sitemap pinging and indexnow key handling ([#7](https://github.com/ethos-link/indexmap/pull/7))
+
+
+
+## [0.4.1] - 2026-04-22
+
+
+### Added
+
+- add output to ping tasks ([#6](https://github.com/ethos-link/indexmap/pull/6))
+
+
+
+## [0.4.0] - 2026-04-22
+
+
+### Documentation
+
+- improve the task messages ([#4](https://github.com/ethos-link/indexmap/pull/4))
+
+
+
+## [0.3.1] - 2026-04-22
+
+
+### Fixed
+
+- fix changelog generation ([#2](https://github.com/ethos-link/indexmap/pull/2))
+
+- harden indexmap runtime defaults and test coverage ([#3](https://github.com/ethos-link/indexmap/pull/3))
+
+
+
+## [0.3.0] - 2026-04-22
+
+
+### Added
+
+- expand indexmap with sitemap parsing, validation, and search engine pinging
+
+
+
+## [0.2.1] - 2026-04-21
+
+
+### Fixed
+
+- publish built gem in release workflow
+
+
+
+## [0.2.0] - 2026-04-21
+
+
+### Added
+
+- add single-file sitemap mode
+
+
+
+## [0.1.0] - 2026-04-21
+
+
+### Added
+
+- bootstrap indexmap gem
 
 
 

data/README.md

@@ -19,9 +19,13 @@ By default, `indexmap` writes a sitemap index plus one or more child sitemap fil
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "indexmap"
+gem "indexmap", require: false
 ```
 
+`require: false` keeps sitemap generation and search-engine clients out of web
+process boot. Require `indexmap` at the application boundary that generates a
+sitemap, or use the task setup below.
+
 And then execute:
 
 ```bash
@@ -38,6 +42,13 @@ Upgrading an existing app? Read [UPGRADE.md](UPGRADE.md) before deploying,
 especially if the app uses custom storage or stores sitemap files under a
 directory prefix such as `sitemaps/`.
 
+## Documentation
+
+- [Search engine ping](docs/search-engine-ping.md): Google Search Console
+  credentials, Google property configuration, and IndexNow key setup.
+- [UPGRADE.md](UPGRADE.md): host-app migration steps for public contract
+  changes.
+
 ## Ruby Usage
 
 ```ruby
@@ -61,6 +72,19 @@ Indexmap::Writer.new(
 
 ## Rails Usage
 
+For an app that uses Indexmap through rake tasks, load the task entrypoint only
+when an Indexmap task is requested. In the application's `Rakefile`, before
+`require_relative "config/application"`:
+
+```ruby
+list_tasks = Rake.application.options.show_tasks || ARGV.any? { |argument| ["-T", "--tasks"].include?(argument) }
+require "indexmap/tasks" if list_tasks || ARGV.any? { |argument| argument.start_with?("indexmap:") }
+```
+
+This preserves `bin/rails --tasks` and the `indexmap:*` tasks without loading
+Indexmap during normal Rails boot. Runtime callers and jobs should explicitly
+`require "indexmap"` immediately before configuring or using the gem.
+
 In an initializer:
 
 ```ruby
@@ -276,6 +300,8 @@ The built-in validator checks for:
 ## Search Engine Ping
 
 `indexmap` can ping Google Search Console and IndexNow after sitemap generation.
+See [Search engine ping](docs/search-engine-ping.md) for Google credential
+setup, Search Console property configuration, and IndexNow key provisioning.
 
 Available rake tasks:
 
@@ -287,77 +313,9 @@ bin/rails indexmap:index_now:write_key
 bin/rails indexmap:ping
 ```
 
-### Google Search Console
-
-Google pinging requires service account credentials:
-
-```ruby
-Indexmap.configure do |config|
-  config.google.credentials = -> { ENV["GOOGLE_SITEMAP"] }
-end
-```
-
-If `config.google.credentials` is blank, `indexmap:google:ping` skips Google submission.
-
-You can optionally override the Search Console property identifier:
-
-```ruby
-Indexmap.configure do |config|
-  config.google.credentials = -> { ENV["GOOGLE_SITEMAP"] }
-  config.google.property = -> { "sc-domain:example.com" }
-end
-```
-
-If `config.google.property` is not set, `indexmap` defaults to `sc-domain:<host>`.
-
-### IndexNow
-
-IndexNow submission requires a key. `indexmap` supports two ways to provide it:
-
-- set `config.index_now.key`
-- or keep a valid verification file in the configured storage as `<key>.txt`
-
-Configured-key example:
-
-```ruby
-Indexmap.configure do |config|
-  config.index_now.key = -> { ENV["INDEXNOW_KEY"] }
-end
-```
-
-If `config.index_now.key` is set, `indexmap:sitemap:create` also ensures the matching `<key>.txt` verification file exists in storage. It leaves an existing valid key file unchanged.
-
-If you need a non-standard verification filename, configure it explicitly:
-
-```ruby
-Indexmap.configure do |config|
-  config.index_now.key = -> { ENV["INDEXNOW_KEY"] }
-  config.index_now.key_filename = -> { "#{ENV.fetch("INDEXNOW_KEY")}.txt" }
-end
-```
-
-You can also disable automatic key-file writes entirely:
-
-```ruby
-Indexmap.configure do |config|
-  config.index_now.key = -> { ENV["INDEXNOW_KEY"] }
-  config.index_now.write_key_file = false
-end
-```
-
-If you prefer the file-based flow, run:
-
-```bash
-bin/rails indexmap:index_now:write_key
-```
-
-That task:
-
-- reuses an existing valid key file when present
-- otherwise generates a new key in `<key>.txt`
-- makes that key available to `indexmap:index_now:ping` without adding `config.index_now.key`
-
-If neither a configured key nor a valid key file is present, `indexmap:index_now:ping` skips IndexNow submission.
+If Google credentials are blank, `indexmap:google:ping` skips Google
+submission. If neither a configured IndexNow key nor a valid key file is
+present, `indexmap:index_now:ping` skips IndexNow submission.
 
 ## Development
 
@@ -385,7 +343,12 @@ Note: `Gemfile.lock` is intentionally not tracked for this gem, following normal
 
 ### Git hooks
 
-We use [lefthook](https://lefthook.dev/) with the Ruby [commitlint](https://github.com/arandilopez/commitlint) gem to enforce Conventional Commits on every commit. We also use [Standard Ruby](https://standardrb.com/) to keep code style consistent. CI validates commit messages, Standard Ruby, tests, and git-cliff changelog generation on pull requests and pushes to main/master.
+We use [lefthook](https://lefthook.dev/) with the Ruby
+[commitlint](https://github.com/arandilopez/commitlint) gem to enforce
+Conventional Commits on every commit. We also use
+[Standard Ruby](https://standardrb.com/) to keep code style consistent. CI
+validates commit messages, Standard Ruby, tests, and git-cliff changelog
+generation on pull requests and pushes to main/master.
 
 Run the hook installer once per clone:
 
@@ -395,11 +358,16 @@ bundle exec lefthook install
 
 ## Release
 
-Releases are tag-driven and published by GitHub Actions to RubyGems. Local release commands never publish directly.
+Releases are tag-driven and published by GitHub Actions to RubyGems.
+Local release commands never publish directly.
 
-Install [git-cliff](https://git-cliff.org/) locally before preparing a release. The release task regenerates `CHANGELOG.md` from Conventional Commits.
+Install [git-cliff](https://git-cliff.org/) locally before preparing a
+release. The release task prepends the next `CHANGELOG.md` section from
+Conventional Commits.
 
-Before preparing a release, make sure you are on `main` or `master` with a clean worktree.
+Before preparing a release, make sure you are on `main` or `master` with a
+clean worktree. If the release contains a breaking public-contract change,
+update `UPGRADE.md` with the host-app migration steps first.
 
 Then run one of:
 
@@ -412,12 +380,13 @@ bundle exec rake 'release:prepare[0.1.0]'
 
 The task will:
 
-1. Regenerate `CHANGELOG.md` with `git-cliff`.
+1. Prepend the next `CHANGELOG.md` section with `git-cliff`.
 1. Update `lib/indexmap/version.rb`.
 1. Commit the release changes.
 1. Create and push the `vX.Y.Z` tag.
 
-The `Release` workflow then runs tests, publishes the gem to RubyGems, and creates the GitHub release from the changelog entry.
+The `Release` workflow then runs tests, publishes the gem to RubyGems,
+and creates the GitHub release from the changelog entry.
 
 ## License
 

data/lib/indexmap/creator.rb

@@ -4,7 +4,7 @@ require "nokogiri"
 
 module Indexmap
   class Creator
-    ValidationConfiguration = Struct.new(:base_url, :index_filename, :storage, keyword_init: true)
+    ValidationConfiguration = Struct.new(:base_url, :index_filename, :storage)
 
     def initialize(output:)
       @output = output

data/lib/indexmap/entry.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Indexmap
-  Entry = Struct.new(:loc, :lastmod, keyword_init: true)
+  Entry = Struct.new(:loc, :lastmod)
 end

data/lib/indexmap/parser.rb

@@ -6,7 +6,7 @@ require "uri"
 
 module Indexmap
   class Parser
-    Entry = Struct.new(:loc, :lastmod, :source_sitemap, keyword_init: true)
+    Entry = Struct.new(:loc, :lastmod, :source_sitemap)
 
     def initialize(source: nil, rebase_remote_children: false, index_filename: Indexmap.configuration.index_filename, storage: Indexmap.configuration.storage)
       @source = (source || index_filename).to_s

data/lib/indexmap/railtie.rb

@@ -3,7 +3,7 @@
 module Indexmap
   class Railtie < Rails::Railtie
     rake_tasks do
-      load File.expand_path("../tasks/indexmap_tasks.rake", __dir__)
+      require "indexmap/tasks"
     end
   end
 end

data/lib/indexmap/section.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Indexmap
-  Section = Struct.new(:filename, :entries, keyword_init: true)
+  Section = Struct.new(:filename, :entries)
 end

data/lib/indexmap/storage/file.rb

@@ -2,7 +2,7 @@
 
 module Indexmap
   module Storage
-    File = Struct.new(:filename, :body, :content_type, keyword_init: true) do
+    File = Struct.new(:filename, :body, :content_type) do
       def basename
         ::File.basename(filename)
       end

data/lib/indexmap/task_runner.rb

@@ -13,7 +13,12 @@ module Indexmap
       index_now_key_filename = write_index_now_key if configuration.index_now.write_key_file?
       configuration.run_after_create_callbacks
 
-      {files: written_files.map(&:to_s), written_files: written_files, index_now_key_filename: index_now_key_filename}
+      {
+        files: written_files.map(&:to_s),
+        written_files: written_files,
+        sitemaps: sitemap_details(written_files),
+        index_now_key_filename: index_now_key_filename
+      }
     end
 
     def format
@@ -60,5 +65,27 @@ module Indexmap
     def sitemap_files
       storage.list(prefix: "sitemap", suffix: ".xml")
     end
+
+    def sitemap_details(files)
+      files.map do |filename|
+        {
+          filename: filename.to_s,
+          location: sitemap_location(filename),
+          link_count: sitemap_link_count(filename)
+        }
+      end
+    end
+
+    def sitemap_location(filename)
+      return storage.public_url(filename) if storage.respond_to?(:public_url)
+
+      filename.to_s
+    end
+
+    def sitemap_link_count(filename)
+      document = Nokogiri::XML(storage.read(filename.to_s))
+      document.remove_namespaces!
+      document.xpath("//loc").count
+    end
   end
 end

data/lib/indexmap/tasks.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "indexmap"
+require "rake"
+
+unless Rake::Task.task_defined?("indexmap:sitemap:create")
+  load File.expand_path("../tasks/indexmap_tasks.rake", __dir__)
+end

data/lib/indexmap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Indexmap
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/lib/indexmap.rb

@@ -18,14 +18,17 @@ require_relative "indexmap/entry"
 require_relative "indexmap/output"
 require_relative "indexmap/parser"
 require_relative "indexmap/pinger/base"
-require_relative "indexmap/pinger/google"
-require_relative "indexmap/pinger/index_now"
 require_relative "indexmap/section"
 require_relative "indexmap/task_runner"
 require_relative "indexmap/validator"
 require_relative "indexmap/writer"
 
 module Indexmap
+  module Pinger
+    autoload :Google, File.expand_path("indexmap/pinger/google", __dir__)
+    autoload :IndexNow, File.expand_path("indexmap/pinger/index_now", __dir__)
+  end
+
   class Error < StandardError; end
 
   class ConfigurationError < Error; end

data/lib/tasks/indexmap_tasks.rake

@@ -5,7 +5,11 @@ namespace :indexmap do
       runner = Indexmap::TaskRunner.new
       create_result = runner.create
 
-      puts "Created, formatted, and validated #{file_count(create_result[:files])} in #{storage_description(runner)}."
+      puts "Created, formatted, and validated #{file_count(create_result[:files])}."
+      puts "Files created:"
+      create_result[:sitemaps].each do |sitemap|
+        puts "  - #{sitemap[:location]} (#{link_count(sitemap[:link_count])})"
+      end
       puts "IndexNow key file: #{create_result[:index_now_key_filename]}" if create_result[:index_now_key_filename]
     end
 
@@ -91,6 +95,10 @@ namespace :indexmap do
     runner.storage
   end
 
+  def link_count(count)
+    "#{count} #{(count == 1) ? "link" : "links"}"
+  end
+
   def format_google_ping_failure(failure)
     case failure[:reason]
     when :unauthorized

data/test/indexmap/lazy_loading_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "open3"
+require "rbconfig"
+
+class IndexmapLazyLoadingTest < Minitest::Test
+  def test_entrypoint_does_not_load_search_console_dependencies
+    script = <<~RUBY
+      require "indexmap"
+
+      loaded = $LOADED_FEATURES.grep(%r{/(?:google/apis|googleauth)(?:/|\\.rb)})
+      abort loaded.join("\\n") unless loaded.empty?
+    RUBY
+
+    _stdout, stderr, status = Open3.capture3(
+      RbConfig.ruby,
+      "-I#{File.expand_path("../../lib", __dir__)}",
+      "-e",
+      script
+    )
+
+    assert status.success?, stderr
+  end
+
+  def test_task_entrypoint_registers_tasks
+    script = <<~RUBY
+      require "indexmap/tasks"
+
+      abort "task missing" unless Rake::Task.task_defined?("indexmap:sitemap:create")
+    RUBY
+
+    _stdout, stderr, status = Open3.capture3(
+      RbConfig.ruby,
+      "-I#{File.expand_path("../../lib", __dir__)}",
+      "-e",
+      script
+    )
+
+    assert status.success?, stderr
+  end
+end

data/test/indexmap/task_runner_test.rb

@@ -16,7 +16,7 @@ class IndexmapTaskRunnerTest < Minitest::Test
   end
 
   def test_create_writes_new_sitemap_and_key_file_without_deleting_unrelated_files
-    storage = Indexmap::Storage::Memory.new
+    storage = Indexmap::Storage::Memory.new(public_url: "https://cdn.example.com/sitemaps")
     storage.write("sitemap-pages.xml.gz", "old")
     storage.write("sitemap-extra.xml", "existing")
 
@@ -31,6 +31,18 @@ class IndexmapTaskRunnerTest < Minitest::Test
     assert_equal VALID_KEY, storage.read("#{VALID_KEY}.txt")
     assert_equal ["sitemap-pages.xml", "sitemap.xml"], result[:files]
     assert_equal ["sitemap-pages.xml", "sitemap.xml"], result[:written_files]
+    assert_equal [
+      {
+        filename: "sitemap-pages.xml",
+        location: "https://cdn.example.com/sitemaps/sitemap-pages.xml",
+        link_count: 1
+      },
+      {
+        filename: "sitemap.xml",
+        location: "https://cdn.example.com/sitemaps/sitemap.xml",
+        link_count: 1
+      }
+    ], result[:sitemaps]
     assert_equal "#{VALID_KEY}.txt", result[:index_now_key_filename]
   end
 

data/test/release_task_test.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "rake"
+
+unless respond_to?(:release_version, true)
+  load File.expand_path("../Rakefile", __dir__)
+end
+
+class ReleaseTaskTest < Minitest::Test
+  def test_release_version_increments_patch_from_current_version
+    major, minor, patch = Indexmap::VERSION.split(".").map(&:to_i)
+
+    assert_equal "#{major}.#{minor}.#{patch + 1}", release_version("patch")
+  end
+
+  def test_release_version_accepts_explicit_semantic_version
+    assert_equal "0.3.0", release_version("0.3.0")
+  end
+
+  def test_validate_release_version_rejects_current_version
+    error = assert_raises(ArgumentError) do
+      validate_release_version!("0.2.7", "0.2.7")
+    end
+
+    assert_equal(
+      "Release version 0.2.7 must be newer than current version 0.2.7.",
+      error.message
+    )
+  end
+
+  def test_validate_release_version_rejects_existing_local_tag
+    @local_release_tag_exists = true
+    @remote_release_tag_exists = false
+
+    error = assert_raises(ArgumentError) do
+      validate_release_version!("0.2.8", "0.2.7")
+    end
+
+    assert_equal "Release tag v0.2.8 already exists locally.", error.message
+  end
+
+  def test_validate_release_version_rejects_existing_remote_tag
+    @local_release_tag_exists = false
+    @remote_release_tag_exists = true
+
+    error = assert_raises(ArgumentError) do
+      validate_release_version!("0.2.8", "0.2.7")
+    end
+
+    assert_equal "Release tag v0.2.8 already exists on origin.", error.message
+  end
+
+  def test_remote_release_tag_command_asks_git_to_fail_when_no_tag_matches
+    assert_equal(
+      "git ls-remote --exit-code --tags origin refs/tags/v0.2.8",
+      remote_release_tag_command("v0.2.8")
+    )
+  end
+
+  def test_changelog_command_prepends_the_next_release
+    assert_equal(
+      [
+        "git-cliff",
+        "-c",
+        "cliff.toml",
+        "--unreleased",
+        "--tag",
+        "v0.2.8",
+        "--prepend",
+        "CHANGELOG.md"
+      ],
+      changelog_command("0.2.8")
+    )
+  end
+
+  private
+
+  def local_release_tag_exists?(_tag)
+    @local_release_tag_exists || false
+  end
+
+  def remote_release_tag_exists?(_tag)
+    @remote_release_tag_exists || false
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indexmap
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Paulo Fidalgo
@@ -193,11 +193,13 @@ files:
 - lib/indexmap/storage/filesystem.rb
 - lib/indexmap/storage/memory.rb
 - lib/indexmap/task_runner.rb
+- lib/indexmap/tasks.rb
 - lib/indexmap/validator.rb
 - lib/indexmap/version.rb
 - lib/indexmap/writer.rb
 - lib/tasks/indexmap_tasks.rake
 - test/indexmap/configuration_test.rb
+- test/indexmap/lazy_loading_test.rb
 - test/indexmap/parser_test.rb
 - test/indexmap/pinger/google_test.rb
 - test/indexmap/pinger/index_now_test.rb
@@ -205,6 +207,7 @@ files:
 - test/indexmap/task_runner_test.rb
 - test/indexmap/validator_test.rb
 - test/indexmap/writer_test.rb
+- test/release_task_test.rb
 - test/test_helper.rb
 homepage: https://www.ethos-link.com/opensource/indexmap
 licenses:
@@ -233,7 +236,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Generate sitemap indexes and child sitemaps with plain Ruby
 test_files: []