site_maps 0.0.1.beta3 → 0.1.1

data/docs/README.md

@@ -0,0 +1,67 @@
+# site_maps
+
+Concurrent, adapter-based sitemap.xml generation for Ruby applications.
+
+`site_maps` is a framework-agnostic sitemap builder with built-in Rails support. It produces valid sitemap XML (with full SEO extensions — image, video, news, hreflang, mobile, PageMap), splits large sitemaps into indexed chunks automatically, generates them concurrently across a thread pool, and ships them to the filesystem, S3, or a custom backend through a pluggable adapter layer.
+
+## Contents
+
+- [Getting started](getting-started.md) — install, first sitemap, Rails
+- [Processes](processes.md) — static and dynamic process DSL
+- [Adapters](adapters.md) — filesystem, S3, no-op, custom
+- [CLI](cli.md) — `site_maps generate`
+- [Rack middleware](middleware.md) — serve generated sitemaps from the app
+- [SEO extensions](extensions.md) — image, video, news, hreflang, mobile, PageMap
+- [Events](events.md) — instrumentation hooks
+- [Rails integration](rails.md) — URL helpers, Railtie, precompile
+- [API reference](api.md) — full public API
+
+## Install
+
+```ruby
+# Gemfile
+gem 'site_maps'
+```
+
+## One-minute tour
+
+```ruby
+# config/sitemap.rb
+SiteMaps.use(:file_system) do
+  configure do |config|
+    config.url       = 'https://example.com/sitemap.xml'
+    config.directory = Rails.public_path.to_s
+  end
+
+  process do |s|
+    s.add('/', priority: 1.0, changefreq: 'daily')
+    s.add('/about', lastmod: Time.now)
+
+    Post.find_each do |post|
+      s.add("/posts/#{post.slug}", lastmod: post.updated_at)
+    end
+  end
+end
+```
+
+```bash
+bundle exec site_maps generate --config-file config/sitemap.rb
+```
+
+Generated: `public/sitemap.xml` (plus an indexed chain if the URL set exceeds 50k links).
+
+## Why site_maps
+
+- **Concurrency.** Processes run in a `Concurrent::FixedThreadPool`; threads share a thread-safe repo that handles file splitting.
+- **Pluggable storage.** Write the same sitemap to disk in development and S3 in production by swapping one line.
+- **Incremental sitemaps.** Full URL extensions support — images, videos, news, hreflang alternates, mobile, PageMap.
+- **Dynamic processes.** Parameterized templates like `posts/%{year}-%{month}/sitemap.xml` let you rebuild a single shard without regenerating the whole site.
+
+## Version
+
+- Ruby: `>= 3.2.0`
+- Depends on: `builder ~> 3.0`, `concurrent-ruby >= 1.1`, `rack >= 2.0`, `zeitwerk`, `thor`
+
+## License
+
+MIT.

data/docs/adapters.md

@@ -0,0 +1,143 @@
+# Adapters
+
+An **adapter** is the storage backend for generated sitemap files. Three adapters ship with the gem; a clean interface makes it easy to write your own.
+
+## Built-in adapters
+
+| Adapter | When to use |
+|---------|-------------|
+| `:file_system` | Write to disk. Ideal for local dev, or for serving via the bundled Rack middleware. |
+| `:aws_sdk` | Upload to S3. Production deployments behind CloudFront or similar. |
+| `:noop` | Discard writes. Ideal for tests that care about "what URLs got added" but not "what ended up on disk". |
+
+Select with `SiteMaps.use(<symbol>)`.
+
+## `:file_system`
+
+```ruby
+SiteMaps.use(:file_system) do
+  configure do |config|
+    config.url       = 'https://example.com/sitemap.xml'
+    config.directory = Rails.public_path.to_s     # default: "public/sitemaps"
+  end
+  process { |s| ... }
+end
+```
+
+**Config attributes:**
+
+| Key | Purpose |
+|-----|---------|
+| `url` | Public URL — drives filename layout and is written into sitemap `<loc>` entries. |
+| `directory` | Filesystem root under which files land. |
+
+If `config.url` ends in `.gz`, the adapter writes gzipped files. The middleware transparently decompresses on serve.
+
+## `:aws_sdk`
+
+```ruby
+SiteMaps.use(:aws_sdk) do
+  configure do |config|
+    config.url           = 'https://my-bucket.s3.amazonaws.com/sitemap.xml'
+    config.directory     = '/tmp/sitemaps'          # local scratch space
+    config.bucket        = 'my-bucket'
+    config.region        = ENV.fetch('AWS_REGION', 'us-east-1')
+    config.access_key_id = ENV['AWS_ACCESS_KEY_ID']
+    config.secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+    config.acl           = 'public-read'            # default
+    config.cache_control = 'private, max-age=0, no-cache'
+  end
+  process { |s| ... }
+end
+```
+
+**Config attributes:**
+
+| Key | Default |
+|-----|---------|
+| `bucket` | `ENV['AWS_BUCKET']` |
+| `region` | `ENV.fetch('AWS_REGION', 'us-east-1')` |
+| `access_key_id` | `ENV['AWS_ACCESS_KEY_ID']` |
+| `secret_access_key` | `ENV['AWS_SECRET_ACCESS_KEY']` |
+| `acl` | `"public-read"` |
+| `cache_control` | `"private, max-age=0, no-cache"` |
+| `directory` | Local scratch dir for staging before upload |
+
+The adapter writes locally first (to `directory`), then uploads to S3 with the configured ACL and Cache-Control headers. You'll need `aws-sdk-s3` in your Gemfile:
+
+```ruby
+gem 'aws-sdk-s3'
+```
+
+## `:noop`
+
+```ruby
+SiteMaps.use(:noop) do
+  configure { |c| c.url = 'https://example.com/sitemap.xml' }
+  process { |s| ... }
+end
+```
+
+Writes are discarded. Use it in tests when you want to assert on the URLs being added (via events, for example) without hitting disk.
+
+## Writing a custom adapter
+
+Subclass `SiteMaps::Adapters::Adapter` and implement `write`, `read`, `delete`:
+
+```ruby
+class GoogleCloudStorageAdapter < SiteMaps::Adapters::Adapter
+  class Config < SiteMaps::Configuration
+    attribute :bucket
+    attribute :project_id
+  end
+
+  def write(url, raw_data, **_kwargs)
+    storage = Google::Cloud::Storage.new(project_id: config.project_id)
+    bucket  = storage.bucket(config.bucket)
+    bucket.create_file(StringIO.new(raw_data), path_from(url))
+  end
+
+  def read(url)
+    file = storage.bucket(config.bucket).file(path_from(url))
+    [file.download.string, { content_type: 'application/xml' }]
+  end
+
+  def delete(url)
+    storage.bucket(config.bucket).file(path_from(url))&.delete
+  end
+
+  private
+
+  def path_from(url)
+    URI(url).path[1..]
+  end
+
+  def storage
+    @storage ||= Google::Cloud::Storage.new(project_id: config.project_id)
+  end
+end
+```
+
+Register and use it:
+
+```ruby
+SiteMaps.use(GoogleCloudStorageAdapter) do
+  configure do |config|
+    config.url        = 'https://cdn.example.com/sitemap.xml'
+    config.bucket     = 'my-bucket'
+    config.project_id = 'my-project'
+  end
+  process { |s| ... }
+end
+```
+
+## Adapter interface
+
+| Method | Purpose |
+|--------|---------|
+| `#write(url, raw_data, **kwargs)` | Persist `raw_data` at the location implied by `url`. |
+| `#read(url)` | Return `[raw_data, { content_type: '…' }]` for the given URL. |
+| `#delete(url)` | Remove the file at the URL. |
+| `.config_class` | (optional) Return a `Configuration` subclass to expose adapter-specific settings. |
+
+The adapter base class handles everything else: URL filters, the process registry, and thread-safe URL tracking.

data/docs/api.md

@@ -0,0 +1,154 @@
+# API Reference
+
+## `SiteMaps` (top-level module)
+
+| Method | Description |
+|--------|-------------|
+| `SiteMaps.use(adapter, **opts, &block)` | Register an adapter (`:file_system`, `:aws_sdk`, `:noop`, or a class) and yield its configuration block. |
+| `SiteMaps.define(&block)` | Register a context-aware definition. Called by `.generate` with the `context:` hash splatted as kwargs. |
+| `SiteMaps.configure { |config| ... }` | Mutate global defaults. |
+| `SiteMaps.config` | Return global `Configuration`. |
+| `SiteMaps.generate(config_file:, context: {}, **runner_opts) → Runner` | Load `config_file` and return a `Runner` ready to `.enqueue` and `.run`. |
+| `SiteMaps.current_adapter` | Last-registered adapter (thread-local during `.generate`). |
+| `SiteMaps.logger` | Configurable logger (default `Logger.new($stdout)`). |
+
+### Constants
+
+```ruby
+SiteMaps::MAX_LENGTH   # { links: 50_000, images: 1_000, news: 1_000 }
+SiteMaps::MAX_FILESIZE # 50_000_000 bytes
+```
+
+### Errors
+
+- `SiteMaps::Error` — base error
+- `SiteMaps::AdapterNotFound` — unknown adapter symbol
+- `SiteMaps::AdapterNotSetError` — generate called without an adapter
+- `SiteMaps::FileNotFoundError` — missing file at adapter read
+- `SiteMaps::FullSitemapError` — internal signal that a URL set is full (triggers split)
+- `SiteMaps::ConfigurationError` — invalid config
+
+---
+
+## `SiteMaps::Configuration`
+
+Base configuration. Adapter configs subclass this.
+
+| Attribute | Default | Purpose |
+|-----------|---------|---------|
+| `url` | — (required) | Public URL of the main sitemap index. |
+| `directory` | `"/tmp/sitemaps"` | Local storage directory. |
+| `max_links` | `50_000` | URLs per file before split. |
+| `emit_priority` | `true` | Emit `<priority>`. |
+| `emit_changefreq` | `true` | Emit `<changefreq>`. |
+| `xsl_stylesheet_url` | `nil` | Stylesheet for URL sets. |
+| `xsl_index_stylesheet_url` | `nil` | Stylesheet for the sitemap index. |
+| `ping_search_engines` | `false` | Auto-ping after generation. |
+| `ping_engines` | `{ bing: '...' }` | URL templates per engine; `%{url}` is URL-encoded at ping time. |
+
+---
+
+## `SiteMaps::Adapters::Adapter` (base class)
+
+Abstract base. Subclass to build custom adapters.
+
+| Method | Description |
+|--------|-------------|
+| `.config_class` | Override to return a `Configuration` subclass with adapter-specific attributes. |
+| `#write(url, raw_data, **kwargs)` | Abstract. Persist `raw_data` at the storage location implied by `url`. |
+| `#read(url) → [raw_data, { content_type: '…' }]` | Abstract. |
+| `#delete(url)` | Abstract. |
+| `#configure { |c| ... }` | Yield the adapter's configuration. |
+| `#process(name = :default, location = nil, **kwargs, &block)` | Register a process. |
+| `#external_sitemap(url, lastmod:)` | Add an external sitemap to the index. |
+| `#extend_processes_with(mod)` | Mix `mod` into all process blocks. |
+| `#url_filter { |url, options| ... }` | Register a URL filter. |
+| `#apply_url_filters(url, options)` | Run all filters; returns modified options or `nil` if excluded. |
+| `#reset!` | Clear index and repo. Called before `Runner#run`. |
+
+---
+
+## `SiteMaps::Runner`
+
+Executes enqueued processes concurrently.
+
+```ruby
+Runner.new(adapter = SiteMaps.current_adapter, max_threads: 4, ping: nil)
+```
+
+| Method | Description |
+|--------|-------------|
+| `#enqueue(process_name, **kwargs)` | Queue one process with kwargs. |
+| `#enqueue_remaining` / `#enqueue_all` | Queue every process not yet enqueued. |
+| `#run` | Execute queued processes, finalize index, optionally ping. |
+
+---
+
+## `SiteMaps::SitemapBuilder`
+
+Yielded as `s` inside every `process` block.
+
+| Method | Description |
+|--------|-------------|
+| `#add(path, **options)` | Add one URL to the current URL set. Automatically splits when full. |
+| `#finalize!` | Finalize the current URL set. Called automatically when the process block returns. |
+
+`options` supports every extension documented in [extensions.md](extensions.md): `lastmod`, `priority`, `changefreq`, `images`, `videos`, `news`, `alternates`, `mobile`, `pagemap`.
+
+In Rails apps, `s.route` is an object exposing all URL helpers.
+
+---
+
+## `SiteMaps::Middleware`
+
+Rack middleware for serving generated sitemaps. See [middleware.md](middleware.md).
+
+```ruby
+use SiteMaps::Middleware,
+  adapter: ...,
+  public_prefix: nil,
+  storage_prefix: nil,
+  x_robots_tag: 'noindex, follow',
+  cache_control: 'public, max-age=3600'
+```
+
+---
+
+## `SiteMaps::Notification`
+
+| Method | Description |
+|--------|-------------|
+| `.subscribe(event_or_class, &block)` | Subscribe to one event (string) or every event named on a class. |
+| `.unsubscribe(subscriber)` | Remove a subscription. |
+| `.instrument(event, payload) { ... }` | Emit an event, wrapping the block in a timer. |
+
+See [events.md](events.md) for the event catalog.
+
+---
+
+## `SiteMaps::RobotsTxt`
+
+| Method | Description |
+|--------|-------------|
+| `.sitemap_directive(url) → String` | Return `"Sitemap: <url>"`. |
+| `.render(sitemap_url:, extra_directives: []) → String` | Build a full robots.txt body. |
+
+---
+
+## `SiteMaps::Ping`
+
+| Method | Description |
+|--------|-------------|
+| `.ping(url, engines: { bing: '...' }) → Hash` | Fire a GET to each engine's template (substituting `%{url}`). Returns a hash of `{engine => { status:, url: }}`. |
+
+---
+
+## CLI entry point
+
+`exec/site_maps` — the executable shipped with the gem.
+
+```bash
+bundle exec site_maps generate [processes] [options]
+```
+
+See [cli.md](cli.md).

data/docs/cli.md

@@ -0,0 +1,93 @@
+# CLI
+
+The gem installs a `site_maps` executable backed by Thor.
+
+```bash
+bundle exec site_maps generate [PROCESS_NAMES...] [options]
+```
+
+If no process names are given, every process in the config file is enqueued.
+
+## Options
+
+| Flag | Default | Purpose |
+|------|---------|---------|
+| `--config-file`, `-r` | — | Path to the config file defining processes. **Required.** |
+| `--max-threads`, `-c` | `4` | Thread pool size for concurrent process execution. |
+| `--context` | `{}` | Hash-style kwargs passed to `SiteMaps.define` blocks: `--context=tenant:acme locale:en`. |
+| `--enqueue-remaining` | `false` | In addition to specified processes, enqueue any others. |
+| `--ping` | `false` | Override config to ping search engines after generation. |
+| `--debug` | `false` | Set logger to DEBUG level. |
+| `--logfile` | — | Write logs to a file instead of stdout. |
+
+## Examples
+
+Generate everything:
+
+```bash
+bundle exec site_maps generate --config-file config/sitemap.rb
+```
+
+Regenerate a single shard of a dynamic process:
+
+```bash
+bundle exec site_maps generate monthly_posts \
+  --config-file config/sitemap.rb \
+  --context=year:2024 month:3
+```
+
+Generate `posts` and `products`, then let the config decide what else to include:
+
+```bash
+bundle exec site_maps generate posts products \
+  --config-file config/sitemap.rb \
+  --enqueue-remaining
+```
+
+Tune concurrency:
+
+```bash
+bundle exec site_maps generate --config-file config/sitemap.rb --max-threads 10
+```
+
+Ping Bing and any custom engines (config-driven — see below):
+
+```bash
+bundle exec site_maps generate --config-file config/sitemap.rb --ping
+```
+
+## Search-engine pinging
+
+Pinging is off by default. Enable globally in config or flip it on per run via `--ping`.
+
+```ruby
+SiteMaps.use(:file_system) do
+  configure do |config|
+    config.url                 = 'https://example.com/sitemap.xml'
+    config.ping_search_engines = true
+    config.ping_engines = {
+      bing:   'https://www.bing.com/ping?sitemap=%{url}',
+      custom: 'https://search.example.com/ping?url=%{url}'
+    }
+  end
+end
+```
+
+`%{url}` in the template is replaced with a URL-encoded `config.url` at ping time.
+
+## Rails / bundler
+
+The CLI auto-requires `config/environment` if it detects a `config/application.rb`, so Rails URL helpers (via the Railtie) are available inside your config file.
+
+If you don't want that — say, a Ruby-only script in a Rails repo — pass a config file outside the Rails root or invoke the library directly via `SiteMaps.generate(...)`.
+
+## Logging
+
+- `--debug` sets the logger to `Logger::DEBUG`.
+- `--logfile PATH` writes to a file; otherwise stdout.
+- A built-in event listener prints one line per finalized URL set with link counts and runtime.
+
+## Exit codes
+
+- `0` — success.
+- Non-zero — any process raised. Errors are captured per-future and re-raised after all futures complete, so you see the real backtrace rather than a generic runner failure.

data/docs/events.md

@@ -0,0 +1,79 @@
+# Events
+
+`site_maps` ships a lightweight pub/sub system under `SiteMaps::Notification`. Use it for logging, metrics, or reacting to particular generation phases.
+
+## Subscribing
+
+### Block subscribers
+
+```ruby
+SiteMaps::Notification.subscribe('sitemaps.finalize_urlset') do |event|
+  Rails.logger.info(
+    "[sitemap] wrote #{event[:links_count]} urls to #{event[:url]} in #{event[:runtime]}s"
+  )
+end
+```
+
+### Class subscribers
+
+A class with one method per event name (dots become underscores):
+
+```ruby
+class SitemapMetrics
+  def self.sitemaps_process_execution(event)
+    StatsD.timing('sitemaps.process', event[:runtime], tags: ["process:#{event[:process].name}"])
+  end
+
+  def self.sitemaps_finalize_urlset(event)
+    StatsD.increment('sitemaps.urlset.written', tags: ["url:#{event[:url]}"])
+  end
+
+  def self.sitemaps_ping(event)
+    event[:results].each do |engine, result|
+      StatsD.increment('sitemaps.ping', tags: ["engine:#{engine}", "status:#{result[:status]}"])
+    end
+  end
+end
+
+SiteMaps::Notification.subscribe(SitemapMetrics)
+```
+
+### The built-in listener
+
+For colored terminal output during CLI runs:
+
+```ruby
+SiteMaps::Notification.subscribe(SiteMaps::Runner::EventListener)
+```
+
+This is subscribed automatically by the CLI.
+
+## Events
+
+| Event | Payload keys |
+|-------|-------------|
+| `sitemaps.enqueue_process` | `process`, `kwargs` |
+| `sitemaps.before_process_execution` | `process`, `kwargs` |
+| `sitemaps.process_execution` | `process`, `kwargs`, `runtime` |
+| `sitemaps.finalize_urlset` | `url`, `links_count`, `news_count`, `last_modified`, `runtime`, `process` |
+| `sitemaps.ping` | `results` |
+
+`process` is a `SiteMaps::Process` struct (`name`, `location_template`, `kwargs_template`, `block`).
+
+## Event ordering
+
+For each process the sequence is:
+
+1. `sitemaps.enqueue_process`
+2. `sitemaps.before_process_execution`
+3. One or more `sitemaps.finalize_urlset` (one per split file)
+4. `sitemaps.process_execution`
+
+After all processes complete, one final `sitemaps.finalize_urlset` fires for the sitemap index itself. If pinging is enabled, `sitemaps.ping` fires last.
+
+## Use cases
+
+- **Logging.** Tail-friendly output of what just ran, how many URLs, runtime.
+- **Metrics.** StatsD / OpenTelemetry counters for throughput and ping outcomes.
+- **Alerting.** Subscribe to `sitemaps.ping`, alert on non-200 results.
+- **Cache busting.** After `sitemaps.finalize_urlset`, purge the CDN entry for the written URL.

data/docs/extensions.md

@@ -0,0 +1,141 @@
+# SEO Extensions
+
+`s.add` accepts options for every sitemap extension recognized by Google and Bing. Pass any of the following alongside `lastmod`, `priority`, and `changefreq`.
+
+## Image
+
+Up to 1,000 images per URL.
+
+```ruby
+s.add('/gallery/summer', images: [
+  {
+    loc:          'https://cdn.example.com/summer/beach.jpg',
+    title:        'Beach sunset',
+    caption:      'A photo from the summer trip',
+    geo_location: 'Cape Cod, MA',
+    license:      'https://creativecommons.org/licenses/by/4.0/'
+  }
+])
+```
+
+## Video
+
+Up to 1,000 video entries per sitemap file.
+
+```ruby
+s.add('/videos/how-to', videos: [
+  {
+    thumbnail_loc:         'https://cdn.example.com/thumbs/how-to.jpg',
+    title:                 'How to use site_maps',
+    description:           'A quick walkthrough',
+    content_loc:           'https://cdn.example.com/videos/how-to.mp4',
+    player_loc:            'https://example.com/embed/how-to',
+    duration:              600,
+    publication_date:      Time.now,
+    rating:                4.8,
+    view_count:            12_345,
+    family_friendly:       true,
+    requires_subscription: false,
+    live:                  false,
+    tags:                  %w[tutorial guide],
+    category:              'Technology',
+    uploader:              'example-team',
+    uploader_info:         'https://example.com/about',
+    gallery_loc:           'https://example.com/videos',
+    gallery_title:         'Example video gallery',
+    price:                 nil,
+    allow_embed:           true,
+    autoplay:              'ap=1'
+  }
+])
+```
+
+## News
+
+Up to 1,000 news entries per sitemap file (use a dedicated process for news URLs).
+
+```ruby
+s.add('/news/breaking', news: {
+  publication_name:     'Example Times',
+  publication_language: 'en',
+  publication_date:     Time.now,
+  title:                'Breaking news headline',
+  keywords:             'breaking, politics',
+  genres:               'PressRelease',
+  access:               'Subscription',
+  stock_tickers:        'NASDAQ:EXMP'
+})
+```
+
+## Alternate language / hreflang
+
+```ruby
+s.add('/', alternates: [
+  { href: 'https://example.com/en', lang: 'en' },
+  { href: 'https://example.com/es', lang: 'es' },
+  { href: 'https://example.com/fr', lang: 'fr', nofollow: true }
+])
+```
+
+The `nofollow: true` variant emits `rel="nofollow alternate"` on the link. Use it to declare locale variants without signalling Google to crawl them as equivalents.
+
+## Mobile
+
+Declare a URL as mobile-friendly:
+
+```ruby
+s.add('/mobile-page', mobile: true)
+```
+
+## PageMap
+
+Structured data for Google Custom Search.
+
+```ruby
+s.add('/products/widget', pagemap: {
+  dataobjects: [
+    {
+      type: 'product',
+      id:   'sku-123',
+      attributes: [
+        { name: 'name',  value: 'Widget' },
+        { name: 'price', value: '19.99' },
+        { name: 'color', value: 'blue' }
+      ]
+    }
+  ]
+})
+```
+
+## Combined example
+
+Everything can coexist on a single URL:
+
+```ruby
+s.add('/products/widget',
+  lastmod:    Time.now,
+  priority:   0.9,
+  changefreq: 'weekly',
+  images:     [{ loc: 'https://cdn.example.com/widget.jpg', title: 'Widget' }],
+  alternates: [{ href: 'https://example.com/es/products/widget', lang: 'es' }],
+  mobile:     true,
+  pagemap:    { dataobjects: [{ type: 'product', id: 'sku-123', attributes: [] }] }
+)
+```
+
+## Disabling `priority` / `changefreq`
+
+Both fields are optional per the sitemap spec, and many search engines ignore them. Disable globally if you want smaller files:
+
+```ruby
+configure do |config|
+  config.emit_priority   = false
+  config.emit_changefreq = false
+end
+```
+
+## Output size
+
+- Per URL set: 50,000 links **or** 1,000 news items **or** 50 MB uncompressed — whichever comes first. When one of these is hit, the current file is finalized and a new one starts.
+- File naming is automatic (`posts/sitemap.xml` → `posts/sitemap1.xml`, `posts/sitemap2.xml`, …).
+- Use the `.gz` extension in `config.url` to emit gzipped files — most search engines fetch either form.