js_from_routes 4.0.2 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13b5b3af46d9a41f4ae0628b9d615fed9e17d564be52db3feabd3d72746cdc8d
-  data.tar.gz: 509f343953d3b610ce0d5ee41558ad92464cbb28866f49cbb5589112b1638220
+  metadata.gz: 1c5e43fa00d907a28931b13ec417afb2d7ef602fdb1b9c47ccd9e00289b305ec
+  data.tar.gz: 4bf4c33ffd5adf831f940f82d51e68af66cc7be9199c5fcbcd957ab4cf2858be
 SHA512:
-  metadata.gz: b71c17a8b7023eff5918bd35eea370e15cd141db8bc07a196e7b093c048208848cf6df117d04d084e21adb882e7077e283255c02ab162c2169c2ffa18eeadb07
-  data.tar.gz: 53288df1b91c1bbc2562cb249e659cfb8e4117223e0503eb3db1e79d3b6376d31da161875b884b64ef484aba17c3253cfc3a298bbd09193f1eb9cecf909235cf
+  metadata.gz: d55050b0f4b4168db33c7db98fa51323fb469e5b8ffd0f484da07860d6834d1a23db1537fcb05414422ec14d344f31fa15f784aac33d283b5365baa45caebda5
+  data.tar.gz: fa99b4558aae4ad1e91fc6ab4792b058f928232565f521c98e32344bd304e548fc8cfcac873e31c13ca1be06a170bbc9a3d13db8ddc88cc89eacfcf367e4612d

data/CHANGELOG.md

@@ -1,3 +1,36 @@
+# [5.0.0](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@4.1.0...js_from_routes@5.0.0) (2026-10-19)
+
+
+### Features
+
+* remove cache-key headers and watch route changes ([#72](https://github.com/ElMassimo/js_from_routes/issues/72)) ([2d34fc1](https://github.com/ElMassimo/js_from_routes/commit/2d34fc1015157339ce9c39bd0c30cf30a34abdb1))
+
+
+
+# [5.0.0](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@4.1.0...js_from_routes@5.0.0) (2026-10-17)
+
+
+### BREAKING CHANGES
+
+* requires Rails 7.2 or newer, which is what CI has been testing against. The development reloader relies on `RoutesReloader#external_routes` and `config.file_watcher`.
+
+
+### Features
+
+* generated files no longer start with a `// JsFromRoutes CacheKey` header. Files are compared by content and only written when they changed, which removes a frequent source of merge conflicts. Run `bin/rake js_from_routes:generate` once after upgrading to drop the header from existing files.
+* in development, helpers are generated at boot and then only when a routes file or a template changes, instead of on every reload.
+* `JS_FROM_ROUTES_FORCE` is no longer needed and has been removed.
+
+
+# [4.1.0](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@4.0.2...js_from_routes@4.1.0) (2026-08-03)
+
+
+### Features
+
+* support multiple generator instances for sub-app routing ([#70](https://github.com/ElMassimo/js_from_routes/issues/70)) ([49d944b](https://github.com/ElMassimo/js_from_routes/commit/49d944b7fcde885f1e8b26312738450a4a3f9136))
+
+
+
 ## [4.0.2](https://github.com/ElMassimo/js_from_routes/compare/js_from_routes@4.0.1...js_from_routes@4.0.2) (2025-01-15)
 
 

data/lib/js_from_routes/generator.rb

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require "digest"
 require "erubi"
 require "fileutils"
-require "pathname"
 
 # Public: Automatically generates JS for Rails routes with { export: true }.
 # Generates one file per controller, and one function per route.
@@ -24,12 +22,6 @@ module JsFromRoutes
         }
     end
 
-    # Public: Used to check whether the file should be generated again, changes
-    # based on the configuration, and route definition.
-    def cache_key
-      routes.map(&:inspect).join + [File.read(@config.template_path), @config.helper_mappings.inspect, @config.client_library].join
-    end
-
     # Public: Exposes the preferred import library to the generator.
     def client_library
       @config.client_library
@@ -87,7 +79,7 @@ module JsFromRoutes
       @mappings.fetch(helper, helper)
     end
 
-    # Internal: Useful as a cache key for the route, and for debugging purposes.
+    # Internal: Useful for debugging purposes.
     def inspect
       "#{verb} #{helper} #{path}"
     end
@@ -100,10 +92,10 @@ module JsFromRoutes
       @compiled_template = Erubi::Engine.new(File.read(template_path), filename: template_path).src
     end
 
-    # Public: Checks if the cache is fresh, or renders the template with the
-    # specified variables, and writes the updated result to a file.
+    # Public: Renders the template with the specified variables, and writes the
+    # result to a file unless it already has the same content.
     def write_if_changed(object)
-      write_file_if_changed(object.filename, object.cache_key) { render_template(object) }
+      write_file_if_changed(object.filename) { render_template(object) }
     end
 
     private
@@ -113,25 +105,16 @@ module JsFromRoutes
       object.instance_eval(@compiled_template)
     end
 
-    # Internal: Returns true if the cache key has changed since the last codegen.
-    def stale?(file, cache_key_comment)
-      ENV["JS_FROM_ROUTES_FORCE"] || file.gets != cache_key_comment
-    end
-
-    # Internal: Writes if the file does not exist or the cache key has changed.
-    # The cache strategy consists of a comment on the first line of the file.
+    # Internal: Writes the file unless it already has the same content, which
+    # keeps mtimes stable so file watchers don't react to no-op generations.
     #
-    # Yields to receive the rendered file content when it needs to.
-    def write_file_if_changed(name, cache_key)
+    # Yields to receive the rendered file content.
+    def write_file_if_changed(name)
+      content = yield
+      return if name.exist? && name.read == content
+
       FileUtils.mkdir_p(name.dirname)
-      cache_key_comment = "// JsFromRoutes CacheKey #{Digest::MD5.hexdigest(cache_key)}\n"
-      File.open(name, "a+") { |file|
-        if stale?(file, cache_key_comment)
-          file.truncate(0)
-          file.write(cache_key_comment)
-          file.write(yield)
-        end
-      }
+      name.write(content)
     end
   end
 
@@ -155,28 +138,40 @@ module JsFromRoutes
   end
 
   class TemplateConfig
-    attr_reader :cache_key, :filename, :helpers
+    attr_reader :filename, :helpers
 
-    def initialize(cache_key:, filename:, helpers: nil)
-      @cache_key = cache_key
+    def initialize(filename:, helpers: nil)
       @filename = filename
       @helpers = helpers
     end
   end
 
-  class << self
-    # Public: Configuration of the code generator.
-    def config
-      @config ||= Configuration.new(::Rails.root || Pathname.new(Dir.pwd))
-      yield(@config) if block_given?
-      @config
+  # Public: A generator instance with its own configuration. Allows generating
+  # routes separately for different sub-apps in a Rails monolith.
+  #
+  # Example:
+  #   JsFromRoutes.config(:admin) do |config|
+  #     config.output_folder = Rails.root.join("app/javascript/admin/api")
+  #     config.export_if = ->(route) { route.defaults[:export] == :admin }
+  #   end
+  #
+  #   JsFromRoutes.config(:public) do |config|
+  #     config.output_folder = Rails.root.join("app/javascript/public/api")
+  #     config.export_if = ->(route) { route.defaults[:export] == :public }
+  #   end
+  class Instance
+    attr_reader :name, :config
+
+    def initialize(name, config)
+      @name = name
+      @config = config
     end
 
     # Public: Generates code for the specified routes with { export: true }.
     def generate!(app_or_routes = Rails.application)
       raise ArgumentError, "A Rails app must be defined, or you must specify a custom `output_folder`" if config.output_folder.to_s.blank?
       rails_routes = app_or_routes.is_a?(::Rails::Engine) ? app_or_routes.routes.routes : app_or_routes
-      generate_files exported_routes_by_controller(rails_routes)
+      generate_files(exported_routes_by_controller(rails_routes))
     end
 
     private
@@ -198,12 +193,10 @@ module JsFromRoutes
       index_file = (config.all_helpers_file == true) ? "index#{preferred_extension}" : config.all_helpers_file
 
       Template.new(config.template_all_path).write_if_changed TemplateConfig.new(
-        cache_key: routes.map(&:import_filename).join + File.read(config.template_all_path),
         filename: config.output_folder.join("all#{preferred_extension}"),
         helpers: routes,
       )
       Template.new(config.template_index_path).write_if_changed TemplateConfig.new(
-        cache_key: File.read(config.template_index_path),
         filename: config.output_folder.join(index_file),
       )
     end
@@ -221,4 +214,88 @@ module JsFromRoutes
         .group_by { |route| namespace_for_route(route)&.to_s }
     end
   end
+
+  class << self
+    # Public: Configuration of the code generator.
+    #
+    # Without a name, returns/yields the default global configuration:
+    #   JsFromRoutes.config do |config|
+    #     config.file_suffix = "Api.ts"
+    #   end
+    #
+    # With a name, defines a named generator instance with its own configuration,
+    # allowing separate route generation for different sub-apps:
+    #   JsFromRoutes.config(:admin) do |config|
+    #     config.output_folder = Rails.root.join("app/javascript/admin/api")
+    #     config.export_if = ->(route) { route.defaults[:export] == :admin }
+    #   end
+    def config(name = nil)
+      if name
+        root = ::Rails.root || Pathname.new(Dir.pwd)
+        new_config = Configuration.new(root)
+        yield(new_config) if block_given?
+        instances[name] = Instance.new(name, new_config)
+      else
+        @config ||= Configuration.new(::Rails.root || Pathname.new(Dir.pwd))
+        if block_given?
+          @config_customized = true
+          yield(@config)
+        end
+        @config
+      end
+    end
+
+    # Public: Returns all registered named instances.
+    def instances
+      @instances ||= {}
+    end
+
+    # Public: Generates code for the specified routes with { export: true }.
+    #
+    # Runs every named instance, plus the default global config whenever it was
+    # explicitly configured (or when no named instances exist at all). This keeps
+    # mixed usage working: adding a named instance never silently disables the
+    # global config that an existing app already relies on.
+    def generate!(app_or_routes = Rails.application)
+      runnable_instances.each { |inst| inst.generate!(app_or_routes) }
+    end
+
+    # Public: Generates code on the first call, and afterwards only when a
+    # routes file or a template changed, so that reloads unrelated to routes
+    # don't pay for iterating every route.
+    def generate_if_changed(app = Rails.application)
+      watcher(app).execute_if_updated
+    end
+
+    # Public: Watches the files Rails loads routes from, and the templates.
+    # Generates once when created, so that helpers are fresh after boot.
+    #
+    # Registered as a Rails reloader by the railtie, so that editing a
+    # template triggers a reload even when no autoloaded file changed.
+    def watcher(app = Rails.application)
+      @watcher ||= app.config.file_watcher.new(watched_files(app), watched_dirs(app)) { generate!(app) }
+        .tap { generate!(app) }
+    end
+
+    private
+
+    def runnable_instances
+      runnable = instances.values
+      runnable.unshift(Instance.new(:default, config)) if @config_customized || runnable.empty?
+      runnable
+    end
+
+    # Internal: The files Rails loads routes from, plus the templates, which
+    # also determine the generated output.
+    def watched_files(app)
+      templates = runnable_instances.flat_map { |inst|
+        [inst.config.template_path, inst.config.template_all_path, inst.config.template_index_path]
+      }
+      (app.routes_reloader.paths + templates).map(&:to_s).uniq
+    end
+
+    def watched_dirs(app)
+      app.routes_reloader.external_routes.to_h { |dir| [dir.to_s, %w[rb]] }
+    end
+  end
 end

data/lib/js_from_routes/railtie.rb

@@ -10,7 +10,11 @@ class JsFromRoutes::Railtie < Rails::Railtie
     # Allows to automatically trigger code generation after updating routes.
     initializer "js_from_routes.reloader" do |app|
       app.config.to_prepare do
-        JsFromRoutes.generate!(app)
+        JsFromRoutes.generate_if_changed(app)
+      end
+
+      app.config.after_initialize do
+        app.reloaders << JsFromRoutes.watcher(app)
       end
     end
   end

data/lib/js_from_routes/template.js.erb

@@ -1,4 +1,3 @@
-//
 // DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
 import { definePathHelper } from '<%= client_library %>'
 

data/lib/js_from_routes/template_all.js.erb

@@ -1,4 +1,3 @@
-//
 // DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
 <% helpers.each do |helper| %>
 export { default as <%= helper.js_name %> } from './<%= helper.import_filename %>'

data/lib/js_from_routes/template_index.js.erb

@@ -1,4 +1,3 @@
-//
 // DO NOT MODIFY: This file was automatically generated by JsFromRoutes.
 import * as helpers from './all'
 export * from './all'

data/lib/js_from_routes/version.rb

@@ -4,5 +4,5 @@
 # Generates one file per controller, and one function per route.
 module JsFromRoutes
   # Public: This library adheres to semantic versioning.
-  VERSION = "4.0.2"
+  VERSION = "5.0.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: js_from_routes
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 5.0.0
 platform: ruby
 authors:
 - Máximo Mussini
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2026-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: '9'
@@ -34,16 +34,22 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: listen
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: readline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -104,16 +124,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement