indexmap 0.8.0 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e1e66f1d2afc109e4475d63d4c24c4e66d4da6a50e729b1f67f325bf729b792
-  data.tar.gz: ce2d2d9f892c510b337e7c2155cc304044a9182722588172456c82b737e196d3
+  metadata.gz: 2f78184d7ab33df85d653a915d6b9e42f7c5409fe0e01bb81991b358616cf4f5
+  data.tar.gz: 739a22b6445ca41a090d296c7c30ea3e96fd08c120fce59dbca41ca76c5c57b5
 SHA512:
-  metadata.gz: 0ad6376f15ef8e5f734c952ae209b472cdefeeb195c641c05e84413f58a3f699f33a8dd6145d661df14c3603fa26268829fae0028da66496bc222f85a3a3c21b
-  data.tar.gz: 2a1c8520caabe2cd2650dda8fd62e77fb9a3a55f85d508b38eb2529d1a658701c15fb65a168e65d278587b55ecbeae15d6bba929b17a1d1855dace51e6d205cd
+  metadata.gz: a78824d383358e1bbc36ebccc37e5cda6d2311a1d37cfd5941f09c7f3a39d30a8023b94dfffdb812b37dd95e754ef908e6a73a3368a861bb761c960b192e19ef
+  data.tar.gz: 89b5cca3351e953d92a7d0b712b56a7856c47564168e759dcd6dbb5e672e7d714ef62e864f1172bc4b4cbedb129801da9bae68fd1542d8d773f77a13314cfc63

data/CHANGELOG.md

@@ -5,6 +5,15 @@ 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.1] - 2026-07-21
+
+
+### Added
+
+- add lazy install generator ([#17](https://github.com/ethos-link/indexmap/pull/17))
+
+
+
 ## [0.8.0] - 2026-07-21
 
 

data/README.md

@@ -72,20 +72,18 @@ 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"`:
+Run the install generator after adding the gem:
 
-```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:") }
+```bash
+bin/rails generate indexmap:install
 ```
 
-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.
+The generator creates `config/initializers/indexmap.rb` with an idempotent
+`IndexmapConfiguration.apply` loader and adds conditional `indexmap/tasks`
+loading to the application's `Rakefile`. This preserves `bin/rails --tasks` and
+the `indexmap:*` tasks without loading Indexmap during normal Rails boot.
 
-In an initializer:
+Customize the `Indexmap.configure` block inside the generated initializer:
 
 ```ruby
 Indexmap.configure do |config|
@@ -109,6 +107,17 @@ Indexmap.configure do |config|
 end
 ```
 
+Runtime callers and jobs must apply the generated configuration before using
+Indexmap:
+
+```ruby
+IndexmapConfiguration.apply
+Indexmap.create
+```
+
+Rake tasks apply it automatically because `indexmap/tasks` loads the gem before
+Rails evaluates the initializer.
+
 Then run:
 
 ```bash

data/lib/generators/indexmap/install_generator.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "rails/generators"
+
+module Indexmap
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Create a lazy-safe Indexmap initializer and task loader"
+
+      def create_initializer
+        template "initializer.rb.tt", "config/initializers/indexmap.rb"
+      end
+
+      def configure_rakefile
+        rakefile = File.join(destination_root, "Rakefile")
+        return unless File.exist?(rakefile)
+        return if File.read(rakefile).include?('require "indexmap/tasks"')
+
+        inject_into_file "Rakefile", rakefile_setup, before: /^require_relative ["']config\/application["']/
+      end
+
+      private
+
+      def rakefile_setup
+        <<~RUBY
+          indexmap_tasks_requested = Rake.application.options.show_tasks ||
+            ARGV.any? { |argument| ["-T", "--tasks"].include?(argument) }
+          require "indexmap/tasks" if indexmap_tasks_requested ||
+            ARGV.any? { |argument| argument.start_with?("indexmap:") }
+
+        RUBY
+      end
+    end
+  end
+end

data/lib/generators/indexmap/templates/initializer.rb.tt

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module IndexmapConfiguration
+  MUTEX = Mutex.new
+
+  def self.apply
+    return if @applied
+
+    MUTEX.synchronize do
+      return if @applied
+
+      require "indexmap"
+
+      Indexmap.configure do |config|
+        config.base_url = -> { ENV.fetch("INDEXMAP_BASE_URL", "http://localhost:3000") }
+        config.storage = lambda {
+          Indexmap::Storage::Filesystem.new(
+            path: Rails.public_path,
+            public_url: config.base_url
+          )
+        }
+
+        # Configure the sitemap data owned by your application:
+        # config.sections = -> { Sitemap.sections }
+      end
+
+      @applied = true
+    end
+  end
+end
+
+IndexmapConfiguration.apply if defined?(Indexmap)

data/lib/indexmap/version.rb

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

data/test/indexmap/install_generator_test.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "generators/indexmap/install_generator"
+require "open3"
+require "rbconfig"
+
+class IndexmapInstallGeneratorTest < Minitest::Test
+  def test_generates_lazy_initializer_and_task_loader
+    Dir.mktmpdir do |destination|
+      File.write(File.join(destination, "Rakefile"), <<~RUBY)
+        require_relative "config/application"
+        Rails.application.load_tasks
+      RUBY
+
+      Indexmap::Generators::InstallGenerator.start([], destination_root: destination)
+
+      initializer = File.join(destination, "config/initializers/indexmap.rb")
+      rakefile = File.read(File.join(destination, "Rakefile"))
+
+      assert File.exist?(initializer)
+      assert_includes File.read(initializer), "module IndexmapConfiguration"
+      assert_includes File.read(initializer), "IndexmapConfiguration.apply if defined?(Indexmap)"
+      assert_includes rakefile, 'require "indexmap/tasks"'
+      assert_operator rakefile.index('require "indexmap/tasks"'), :<, rakefile.index('require_relative "config/application"')
+
+      _stdout, stderr, status = Open3.capture3(RbConfig.ruby, initializer)
+      assert status.success?, stderr
+
+      script = <<~RUBY
+        require "pathname"
+
+        module Rails
+          def self.public_path
+            Pathname.new("public")
+          end
+        end
+
+        require "indexmap"
+        load ARGV.fetch(0)
+
+        configuration = Indexmap.configuration
+        IndexmapConfiguration.apply
+        abort "configuration replaced" unless Indexmap.configuration.equal?(configuration)
+        abort "base URL missing" unless configuration.base_url == "http://localhost:3000"
+      RUBY
+      _stdout, stderr, status = Open3.capture3(
+        RbConfig.ruby,
+        "-I#{File.expand_path("../../lib", __dir__)}",
+        "-e",
+        script,
+        initializer
+      )
+      assert status.success?, stderr
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: indexmap
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.8.1
 platform: ruby
 authors:
 - Paulo Fidalgo
@@ -175,6 +175,8 @@ files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
+- lib/generators/indexmap/install_generator.rb
+- lib/generators/indexmap/templates/initializer.rb.tt
 - lib/indexmap.rb
 - lib/indexmap/configuration.rb
 - lib/indexmap/creator.rb
@@ -199,6 +201,7 @@ files:
 - lib/indexmap/writer.rb
 - lib/tasks/indexmap_tasks.rake
 - test/indexmap/configuration_test.rb
+- test/indexmap/install_generator_test.rb
 - test/indexmap/lazy_loading_test.rb
 - test/indexmap/parser_test.rb
 - test/indexmap/pinger/google_test.rb