site_maps 0.0.1.beta3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0b92468df93a09f176223cd329a97253051d3beece1ebd3c33efe2a8a23b109
-  data.tar.gz: 6d47acbaa8f176cd931929100a26ea1c3184005c6a127dc69bea41fa5ff6194f
+  metadata.gz: 9246737e11d28f750005fedc117c0c2afb8c5f5ef606218fc505e1042c4da002
+  data.tar.gz: 80f005cca72244cfe1044c30cf91d1656b22bb7ff3047a2fd159eee2ddd2f3a5
 SHA512:
-  metadata.gz: 58bf88572f4e54bbdf784d33146908198d6fccb4558573946f84ee566a1b2fcb600eada66d81e0c2bc6b4529cee9eb7e631559f1ee863756d8ed561f13beb818
-  data.tar.gz: 4c432015c4a7e2463a22f47742ad779efe2fbcfa7577c408ad50681855bc2b6d8697cde7bc04acb9f8c2113d6f8d41c0571e3c40de53513cf6aa3275ba60a635
+  metadata.gz: 6ebb8a69803018a65c995e61cc714385ae965b04fc8df330cb7a5e99fd37539568cc1661e86da70f1e7e90eef108ba9a9c5ba1bc6e4b50d5c17f41856e4df934
+  data.tar.gz: 9dbf41444903708643f4639ae773470fc2043eeb0deb9061dedccef5ceda30210435db6faec1d1f949baa8200841d7245c40ac97df88f8993b57e5c1caeaa41b

data/.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: "3.0"
+          ruby-version: "3.2"
           bundler-cache: true
       - name: Run rubocop
         run: |
@@ -26,10 +26,9 @@ jobs:
       fail-fast: false
       matrix:
         ruby-version:
-          - "3.0"
-          - "3.1"
           - "3.2"
           - "3.3"
+          - "3.4"
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -42,4 +41,3 @@ jobs:
         run: bundle install --jobs 4 --retry 3
       - name: Run tests
         run: bundle exec rspec
-

data/.rubocop.yml

@@ -2,16 +2,18 @@ inherit_mode:
   merge:
     - Exclude
 
-require:
+plugins:
   - rubocop-performance
   - rubocop-rspec
+
+require:
   - standard/cop/block_single_line_braces
 
 inherit_gem:
   standard: config/base.yml
 
 AllCops:
-  TargetRubyVersion: 2.5
+  TargetRubyVersion: 3.2
   SuggestExtensions: false
   Exclude:
     - "db/**/*"

data/.tool-versions

@@ -1 +1 @@
-ruby 3.3.5
+ruby 3.4.9

data/AGENTS.md

@@ -0,0 +1,73 @@
+# AGENTS.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+```bash
+bundle exec rspec                   # Run all tests
+bundle exec rspec spec/path/to_spec.rb  # Run a single spec file
+bundle exec rspec spec/path/to_spec.rb:42  # Run a single example by line
+bundle exec rubocop                 # Run linter
+bundle exec rubocop -a              # Auto-correct offenses
+bundle exec rake install            # Install gem locally
+```
+
+## Architecture
+
+`SiteMaps` is a concurrent, incremental sitemap.xml generator gem. It is framework-agnostic but ships with a Rails Railtie.
+
+### Adapter Pattern
+
+Storage backends (`FileSystem`, `AwsSdk`, `Noop`) all inherit from `Adapters::Adapter`. Each adapter can ship its own `Config` class (inheriting `SiteMaps::Configuration`) and optional process mixins. The active adapter is stored in `SiteMaps.current_adapter` and set via `SiteMaps.use(:adapter_name, **opts)`.
+
+### Process Model
+
+Work is declared as named **processes**. A process can be **static** (executed once, fixed location) or **dynamic** (executed multiple times with a location template like `posts/%{year}-%{month}/sitemap.xml`). Processes are stored as immutable structs with block callbacks and orchestrated by `Runner`.
+
+### Runner and Concurrency
+
+`Runner` manages a `concurrent-ruby` `FixedThreadPool` (default 4 threads). Processes are enqueued with `enqueue(:name, **args)`, `enqueue_remaining`, or `enqueue_all`, then executed by calling `run`. `AtomicRepository` provides thread-safe tracking of processes and URL sets. `SitemapBuilder` uses a `Mutex` for synchronization.
+
+### XML Generation
+
+`Builder::URLSet` writes a single sitemap XML file (max 50,000 links or ~50MB). When a limit is reached, `IncrementalLocation` generates the next filename automatically. `Builder::SitemapIndex` aggregates multiple URLSets. `Builder::URL` handles sitemap extensions: images, videos, news, alternates, mobile, and pagemap.
+
+### Notification System
+
+`Notification::Publisher` is a mixin that enables event-driven hooks. Key events: `sitemaps.enqueue_process`, `sitemaps.before_process_execution`, `sitemaps.process_execution`, `sitemaps.finalize_urlset`. Subscribe via `SiteMaps.subscribe(event) { |payload| ... }`.
+
+### Configuration
+
+`Configuration` uses an `attribute` macro for declaring settings with defaults. Adapter-specific configs inherit from the base class. Config is set with `SiteMaps.configure { |c| ... }` or inline inside `SiteMaps.use`.
+
+### CLI
+
+Implemented with Thor in `lib/site_maps/cli.rb`, exposed via the `exec/site_maps` binary. The main command is `site_maps generate [processes]` with flags `--config-file`, `--max-threads`, `--context` (key:value pairs for dynamic processes), `--enqueue-remaining`, `--debug`, and `--logfile`.
+
+### Rails Integration
+
+`lib/site_maps/railtie.rb` is auto-loaded when Rails is present. It injects Rails URL helpers into process blocks via a `route` helper method.
+
+## Typical Usage Pattern
+
+```ruby
+# config/sitemap.rb
+SiteMaps.use(:file_system) do
+  configure do |config|
+    config.url = "https://example.com/sitemaps/sitemap.xml.gz"
+    config.directory = Rails.public_path.to_s
+  end
+
+  process do |s|                          # static, default process
+    s.add("/", priority: 1.0)
+  end
+
+  process :posts, "posts/%{year}-%{month}/sitemap.xml", year: 2024, month: 1 do |s, year:, month:|
+    Post.where(year: year, month: month).find_each { |p| s.add(post_path(p)) }
+  end
+end
+
+# Generate
+SiteMaps.generate(config_file: "config/sitemap.rb").enqueue_all.run
+```

data/CHANGELOG.md

@@ -4,5 +4,10 @@ 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.1.1 - 2026-05-12
+
+### Fixed
+- AwsSdk adapter: switched from the deprecated `Aws::S3::Object#upload_file` to `Aws::S3::TransferManager#upload_file` to silence the deprecation warning and keep working past the next aws-sdk-s3 major.
+
 ## 0.0.1.beta1 - 2024-11-07
 The first release of the gem

data/CLAUDE.md

@@ -0,0 +1,77 @@
+# AGENTS.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Commands
+
+```bash
+bundle exec rspec                   # Run all tests
+bundle exec rspec spec/path/to_spec.rb  # Run a single spec file
+bundle exec rspec spec/path/to_spec.rb:42  # Run a single example by line
+bundle exec rubocop                 # Run linter
+bundle exec rubocop -a              # Auto-correct offenses
+bundle exec rake install            # Install gem locally
+```
+
+## Architecture
+
+`SiteMaps` is a concurrent, incremental sitemap.xml generator gem. It is framework-agnostic but ships with a Rails Railtie.
+
+### Adapter Pattern
+
+Storage backends (`FileSystem`, `AwsSdk`, `Noop`) all inherit from `Adapters::Adapter`. Each adapter can ship its own `Config` class (inheriting `SiteMaps::Configuration`) and optional process mixins. The active adapter is stored in `SiteMaps.current_adapter` and set via `SiteMaps.use(:adapter_name, **opts)`.
+
+### Process Model
+
+Work is declared as named **processes**. A process can be **static** (executed once, fixed location) or **dynamic** (executed multiple times with a location template like `posts/%{year}-%{month}/sitemap.xml`). Processes are stored as immutable structs with block callbacks and orchestrated by `Runner`.
+
+### Runner and Concurrency
+
+`Runner` manages a `concurrent-ruby` `FixedThreadPool` (default 4 threads). Processes are enqueued with `enqueue(:name, **args)`, `enqueue_remaining`, or `enqueue_all`, then executed by calling `run`. `AtomicRepository` provides thread-safe tracking of processes and URL sets. `SitemapBuilder` uses a `Mutex` for synchronization.
+
+### XML Generation
+
+`Builder::URLSet` writes a single sitemap XML file (max 50,000 links or ~50MB). When a limit is reached, `IncrementalLocation` generates the next filename automatically. `Builder::SitemapIndex` aggregates multiple URLSets. `Builder::URL` handles sitemap extensions: images, videos, news, alternates, mobile, and pagemap.
+
+### Notification System
+
+`Notification::Publisher` is a mixin that enables event-driven hooks. Key events: `sitemaps.enqueue_process`, `sitemaps.before_process_execution`, `sitemaps.process_execution`, `sitemaps.finalize_urlset`. Subscribe via `SiteMaps.subscribe(event) { |payload| ... }`.
+
+### Configuration
+
+`Configuration` uses an `attribute` macro for declaring settings with defaults. Adapter-specific configs inherit from the base class. Config is set with `SiteMaps.configure { |c| ... }` or inline inside `SiteMaps.use`.
+
+### CLI
+
+Implemented with Thor in `lib/site_maps/cli.rb`, exposed via the `exec/site_maps` binary. The main command is `site_maps generate [processes]` with flags `--config-file`, `--max-threads`, `--context` (key:value pairs for dynamic processes), `--enqueue-remaining`, `--ping`, `--debug`, and `--logfile`.
+
+### Rails Integration
+
+`lib/site_maps/railtie.rb` is auto-loaded when Rails is present. It injects Rails URL helpers into process blocks via a `route` helper method.
+
+## Development Guidelines
+
+- **Any new public-facing feature** (new option, method, CLI flag, or behaviour change) must be documented in `README.md` before the work is considered complete. This includes: new `generate`/`Runner` options, new middleware options, new CLI flags, new config attributes, and new DSL methods.
+
+## Typical Usage Pattern
+
+```ruby
+# config/sitemap.rb
+SiteMaps.use(:file_system) do
+  configure do |config|
+    config.url = "https://example.com/sitemaps/sitemap.xml.gz"
+    config.directory = Rails.public_path.to_s
+  end
+
+  process do |s|                          # static, default process
+    s.add("/", priority: 1.0)
+  end
+
+  process :posts, "posts/%{year}-%{month}/sitemap.xml", year: 2024, month: 1 do |s, year:, month:|
+    Post.where(year: year, month: month).find_each { |p| s.add(post_path(p)) }
+  end
+end
+
+# Generate
+SiteMaps.generate(config_file: "config/sitemap.rb").enqueue_all.run
+```

data/Gemfile

@@ -3,6 +3,7 @@
 source "https://rubygems.org"
 
 gem "aws-sdk-s3"
+gem "base64"
 gem "dotenv"
 gem "nokogiri"
 gem "pry"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    site_maps (0.0.1.beta3)
+    site_maps (0.1.1)
       builder (~> 3.0)
       concurrent-ruby (>= 1.1)
       rack (>= 2.0)
@@ -11,113 +11,129 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.8.7)
-      public_suffix (>= 2.0.2, < 7.0)
-    ast (2.4.2)
-    aws-eventstream (1.3.0)
-    aws-partitions (1.1003.0)
-    aws-sdk-core (3.212.0)
+    addressable (2.9.0)
+      public_suffix (>= 2.0.2, < 8.0)
+    ast (2.4.3)
+    aws-eventstream (1.4.0)
+    aws-partitions (1.1238.0)
+    aws-sdk-core (3.244.0)
       aws-eventstream (~> 1, >= 1.3.0)
       aws-partitions (~> 1, >= 1.992.0)
       aws-sigv4 (~> 1.9)
+      base64
+      bigdecimal
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-kms (1.95.0)
-      aws-sdk-core (~> 3, >= 3.210.0)
+      logger
+    aws-sdk-kms (1.123.0)
+      aws-sdk-core (~> 3, >= 3.244.0)
       aws-sigv4 (~> 1.5)
-    aws-sdk-s3 (1.170.0)
-      aws-sdk-core (~> 3, >= 3.210.0)
+    aws-sdk-s3 (1.219.0)
+      aws-sdk-core (~> 3, >= 3.244.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.5)
-    aws-sigv4 (1.10.1)
+    aws-sigv4 (1.12.1)
       aws-eventstream (~> 1, >= 1.0.2)
-    bigdecimal (3.1.8)
+    base64 (0.3.0)
+    bigdecimal (4.1.1)
     builder (3.3.0)
     coderay (1.1.3)
-    concurrent-ruby (1.3.4)
-    crack (1.0.0)
+    concurrent-ruby (1.3.6)
+    crack (1.0.1)
       bigdecimal
       rexml
-    diff-lcs (1.5.1)
-    dotenv (2.8.1)
-    hashdiff (1.1.1)
+    diff-lcs (1.6.2)
+    dotenv (3.2.0)
+    hashdiff (1.2.1)
+    io-console (0.8.2)
     jmespath (1.6.2)
-    json (2.8.1)
-    language_server-protocol (3.17.0.3)
+    json (2.19.3)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    logger (1.7.0)
     method_source (1.1.0)
-    nokogiri (1.16.7-x86_64-linux)
+    nokogiri (1.19.2-x86_64-linux-gnu)
       racc (~> 1.4)
-    parallel (1.26.3)
-    parser (3.3.6.0)
+    parallel (1.28.0)
+    parser (3.3.11.1)
       ast (~> 2.4.1)
       racc
-    pry (0.14.2)
+    prism (1.9.0)
+    pry (0.16.0)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    public_suffix (5.1.1)
+      reline (>= 0.6.0)
+    public_suffix (7.0.5)
     racc (1.8.1)
-    rack (3.1.8)
+    rack (3.2.6)
     rainbow (3.1.1)
-    regexp_parser (2.9.2)
-    rexml (3.3.9)
-    rspec (3.13.0)
+    regexp_parser (2.12.0)
+    reline (0.6.3)
+      io-console (~> 0.5)
+    rexml (3.4.4)
+    rspec (3.13.2)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.2)
+    rspec-core (3.13.6)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
+    rspec-expectations (3.13.5)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.2)
+    rspec-mocks (3.13.8)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.64.1)
+    rspec-support (3.13.7)
+    rubocop (1.84.2)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.34.1)
-      parser (>= 3.3.1.0)
-    rubocop-performance (1.21.1)
-      rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.2.0)
-      rubocop (~> 1.61)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    rubocop-rspec (3.9.0)
+      lint_roller (~> 1.1)
+      rubocop (~> 1.81)
     ruby-progressbar (1.13.0)
-    standard (1.37.0)
+    standard (1.54.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.64.0)
+      rubocop (~> 1.84.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.4)
+      standard-performance (~> 1.8)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.4.0)
+    standard-performance (1.9.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.21.0)
-    thor (1.3.2)
-    timecop (0.9.10)
-    unicode-display_width (2.6.0)
-    webmock (3.24.0)
+      rubocop-performance (~> 1.26.0)
+    thor (1.5.0)
+    timecop (0.9.11)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    webmock (3.26.2)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.7.1)
+    zeitwerk (2.7.5)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   aws-sdk-s3
+  base64
   dotenv
   nokogiri
   pry