react-manifest-rails 0.2.20 → 0.2.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573c8f1d4441a029cdc192ceef3e3e140702e55a17fc367e195243752f3970d6
-  data.tar.gz: d02437b64aeee8fb45879b9b5d1f740e4eea85b42023ac8fadb84c3c6c491e97
+  metadata.gz: c87f68d7ed8248c19732ce3b946a1207ed85907a92bd39ab5a2eda665f5b001e
+  data.tar.gz: 7ee42c73f25048a31d8ca713d0cdfc23b344eb99ec68d1f72c58b5cfda3b635d
 SHA512:
-  metadata.gz: f4aaf9bc43e9cc067c47790eb98061a0af8ad58efaa61c7c9a663749ca1d3e5cb464881987ca9ee31e015c820578780857cf5b15c9fae2a5d2b7bd0e0ce3038c
-  data.tar.gz: 34273febe66a2821de77756baad5be6e3193234746db4f0ded7ba80d180ba1ce3d0d7a7c01e67456060ae743d5cab2723914ec5e163f1eaefb885f3504177569
+  metadata.gz: d71e1c8b255678a3b1a72df766134b80dadd8bf7553d4380e240d3a8b526dff5e6f6ef848574b93c86f6778feef896cc04b945a0f020d03d0bccf034acfe7d74
+  data.tar.gz: 874538d0cd06e8b8a121d9343a3846649b6612cd3ad4bb8c0c28a7c1589c1e05bf2f48b80ae0fe6a8af478d07a3d4309d9a5bc692536f4cdebeeed90b89ca74c

data/CHANGELOG.md

@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - `react_component` now emits only `ux_shared` plus the direct owning bundle for the requested component symbol, instead of also emitting transitive controller manifests as separate script tags. This prevents unnecessary network requests for additional `ux_*.js` manifests while preserving dependency loading through generated manifest `require` directives.
+- Generator now skips `external_roots` and `external_providers` entries that resolve to files already included in `ux_shared`, preventing duplicate runtime declarations from overlapping shared/external includes.
+- View helper bundle deduplication now canonicalizes bundle names (e.g. `ux_shared` vs `ux_manifests/ux_shared`) to avoid re-emitting equivalent script tags.
 
 ## [0.2.10] - 2026-04-16
 

data/README.md

@@ -84,7 +84,9 @@ In development:
 Generation is **directory-based** — deterministic and conservative by design.
 
 - `ux_shared.js`: every file from directories outside `ux/app/` (i.e. `components/`, `hooks/`, `lib/`, etc.)
-- `ux_<controller>.js`: `ux_shared` + every file under `ux/app/<controller>/`
+- `ux_<controller>.js`: every file under `ux/app/<controller>/`, plus transitive controller dependencies inferred from component usage across `ux/app/*`
+
+`ux_shared.js` is loaded as a separate script by `react_bundle_tag` and `react_component` helpers. It is intentionally not inlined into every `ux_<controller>.js` manifest to avoid duplicating shared code across controller bundles.
 
 Namespace fallback for nested controllers: `admin/reports/summary` tries `ux_admin_reports_summary`, then `ux_admin_reports`, then `ux_admin`, then `ux_summary`. The most specific match wins.
 
@@ -141,6 +143,7 @@ end
 - **`exclude_paths`**: excludes files whose path contains any listed segment. Not based on `application.js`.
 - **`dry_run`**: also honoured by `DRY_RUN=1` environment variable at runtime.
 - **`extensions`**: add `ts` and `tsx` to enable TypeScript source detection.
+- **`external_roots` / `external_providers`**: do not point these at files already inside shared `ux/` dirs (`components/`, `hooks/`, `lib/`, etc.). The generator now skips those overlaps to prevent duplicate declarations in browser runtime.
 
 ## Commands
 
@@ -168,6 +171,22 @@ bundle exec rails react_manifest:watch
 bundle exec rails react_manifest:clean
 ```
 
+## Releasing
+
+The publish workflow runs on tag pushes (`v*`), not on branch pushes.
+
+1. Bump `ReactManifest::VERSION` in `lib/react_manifest/version.rb`.
+2. Run `bundle install` to refresh the local path spec version in `Gemfile.lock`.
+3. Commit and push to `main`/`master`.
+4. Create and push a matching annotated tag:
+
+```bash
+git tag -a vX.Y.Z -m "Release vX.Y.Z"
+git push origin vX.Y.Z
+```
+
+This tag push triggers `.github/workflows/release.yml`, which runs tests, creates a GitHub Release, and publishes to RubyGems.
+
 ## Troubleshooting
 
 ### `AssetNotPrecompiledError` for `ux_*.js`
@@ -216,6 +235,18 @@ If you see errors like `UserSignInForm is not defined` (often from `eval` inside
 
 Using `defer: true` can cause `react_component` inline scripts to run before your `ux_*.js` bundles are executed.
 
+### `Identifier '<Name>' has already been declared`
+
+This usually means the same component/function is being loaded from two separate bundles.
+
+Common cause: a file outside `ux/` (for example `app/assets/javascripts/components/navbar/*` loaded by `application.js`) references a symbol defined in `ux/app/<controller>/...`, while that controller bundle is also loaded via `react_bundle_tag`.
+
+Recommended fix:
+- Move globally reused symbols out of `ux/app/*` into a shared dir (`ux/components`, `ux/hooks`, `ux/lib`) so they are emitted once via `ux_shared.js`.
+- Keep controller-specific symbols in `ux/app/*` and avoid importing/using them from non-ux global assets.
+
+If you use `external_roots`, `react_manifest:analyze` and generation warnings will now flag this pattern explicitly.
+
 ## Compatibility
 
 - Ruby: 3.2+

data/lib/react_manifest/generator.rb

@@ -42,7 +42,7 @@ module ReactManifest
     # written and others stale/missing.
     def run!
       classification = @classifier.classify
-      controller_context = build_controller_context(classification.controller_dirs)
+      controller_context = build_controller_context(classification.controller_dirs, classification.shared_dirs)
 
       # Phase 1: build all content in memory — no I/O.
       manifests = []
@@ -99,12 +99,13 @@ module ReactManifest
       { filename: "#{ctrl[:bundle_name]}.js", content: "#{lines.join("\n")}\n" }
     end
 
-    def build_controller_context(controller_dirs)
+    def build_controller_context(controller_dirs, shared_dirs)
       bundle_files = {}
       symbol_to_bundle = {}
       external_symbol_to_require = {}
       dependencies = Hash.new { |h, k| h[k] = Set.new }
       external_requires = Hash.new { |h, k| h[k] = Set.new }
+      shared_require_paths = shared_require_path_set(shared_dirs)
 
       # Index controller-defined symbols for cross-app detection
       controller_dirs.each do |ctrl|
@@ -126,6 +127,13 @@ module ReactManifest
         abs_root = abs_external_root(root_path)
         external_js_files_in(abs_root).each do |file_path|
           req_path = relative_require_path(file_path)
+          if shared_require_paths.include?(normalize_require_path(req_path))
+            warn "[ReactManifest] Skipping external_roots file already provided by shared bundle: #{req_path}"
+            next
+          end
+
+          warn_on_external_controller_references(file_path, symbol_to_bundle)
+
           extract_defined_symbols(file_path).each do |sym|
             external_symbol_to_require[sym] ||= req_path
           end
@@ -134,6 +142,12 @@ module ReactManifest
 
       # Explicit external_providers win over scanned roots on symbol conflicts
       @config.external_providers.each do |sym, req_path|
+        if shared_require_paths.include?(normalize_require_path(req_path))
+          warn "[ReactManifest] Skipping external provider '#{sym}' because it is already " \
+               "provided by shared bundle: #{req_path}"
+          next
+        end
+
         external_symbol_to_require[sym] = req_path
       end
 
@@ -348,6 +362,29 @@ module ReactManifest
       Rails.root.join(path).to_s
     end
 
+    def shared_require_path_set(shared_dirs)
+      shared_dirs.each_with_object(Set.new) do |shared_dir, paths|
+        js_files_in(shared_dir[:path]).each do |file_path|
+          paths << normalize_require_path(relative_require_path(file_path))
+        end
+      end
+    end
+
+    def normalize_require_path(path)
+      path.to_s.sub(/\.js\.jsx$/, "").sub(/\.jsx$/, "").sub(/\.js$/, "")
+    end
+
+    def warn_on_external_controller_references(file_path, symbol_to_bundle)
+      extract_used_component_symbols(file_path).each do |sym|
+        dep_bundle = symbol_to_bundle[sym]
+        next unless dep_bundle
+
+        warn "[ReactManifest] External file '#{relative_require_path(file_path)}' references " \
+             "controller-only symbol '#{sym}' (#{dep_bundle}). " \
+             "Move '#{sym}' to a shared ux dir to avoid duplicate runtime declarations."
+      end
+    end
+
     def auto_generated?(path)
       # Avoid TOCTOU: don't check existence separately — just attempt the read
       # and treat a missing/unreadable file as not auto-generated.

data/lib/react_manifest/scanner.rb

@@ -57,7 +57,8 @@ module ReactManifest
       Object Array String Number Boolean Symbol Map Set WeakMap
     ].freeze
 
-    Result = Struct.new(:symbol_index, :controller_usages, :warnings, :shared_violations, keyword_init: true)
+    Result = Struct.new(:symbol_index, :controller_usages, :warnings, :shared_violations,
+                        :external_violations, keyword_init: true)
 
     def initialize(config = ReactManifest.configuration)
       @config = config
@@ -67,6 +68,7 @@ module ReactManifest
     def scan(classification)
       warnings      = []
       symbol_index  = {}
+      external_file_paths = {} # file_path => relative_require_path for external_roots files
 
       # Phase 1a: index symbols from shared dirs
       shared_file_paths = {} # file_path => relative_require_path for all shared files
@@ -90,7 +92,8 @@ module ReactManifest
         abs_root = abs_external_root(root_path)
         js_files_in(abs_root).each do |file_path|
           relative = relative_require_path(file_path)
-          symbols  = extract_definitions(file_path)
+          external_file_paths[file_path] = relative
+          symbols = extract_definitions(file_path)
           symbols.each do |sym|
             symbol_index[sym] ||= relative
           end
@@ -119,6 +122,7 @@ module ReactManifest
 
       # Phase 1e: detect shared files that use app-dir (controller) symbols
       shared_violations = detect_shared_violations(shared_file_paths, controller_symbol_index, warnings)
+      external_violations = detect_external_root_violations(external_file_paths, controller_symbol_index, warnings)
 
       # Phase 2: scan controller dirs for usage
       controller_usages = {}
@@ -147,7 +151,8 @@ module ReactManifest
         symbol_index: symbol_index,
         controller_usages: controller_usages,
         warnings: warnings,
-        shared_violations: shared_violations
+        shared_violations: shared_violations,
+        external_violations: external_violations
       )
     end
     # rubocop:enable Metrics/MethodLength,Metrics/AbcSize,Metrics/PerceivedComplexity
@@ -229,6 +234,36 @@ module ReactManifest
       violations
     end
 
+    def detect_external_root_violations(external_file_paths, controller_symbol_index, warnings)
+      violations = []
+      external_file_paths.each do |file_path, relative|
+        content = begin
+          File.read(file_path, encoding: "utf-8")
+        rescue Errno::ENOENT, Errno::EACCES, Encoding::InvalidByteSequenceError
+          next
+        end
+
+        local_syms = Set.new
+        DEFINITION_PATTERNS.each { |p| content.scan(p) { |m| local_syms << m[0] } }
+
+        [PASCAL_TOKEN_PATTERN, HOOK_TOKEN_PATTERN].each do |pattern|
+          content.scan(pattern) do |match|
+            sym = match[0]
+            next if local_syms.include?(sym)
+            next unless controller_symbol_index.key?(sym)
+
+            info = controller_symbol_index[sym]
+            violations << { external_file: relative, symbol: sym,
+                            controller: info[:controller], app_file: info[:file] }
+            warnings << "External file '#{relative}' uses app-dir symbol '#{sym}' " \
+                        "(from ux/app/#{info[:controller]}). " \
+                        "Move '#{sym}' into a shared ux dir to avoid duplicate runtime declarations."
+          end
+        end
+      end
+      violations
+    end
+
     # Count how many controllers use each shared file
     def emit_fanout_warnings(controller_usages, warnings)
       fanout = Hash.new(0)

data/lib/react_manifest/version.rb

@@ -1,3 +1,3 @@
 module ReactManifest
-  VERSION = "0.2.20".freeze
+  VERSION = "0.2.22".freeze
 end

data/lib/react_manifest/view_helpers.rb

@@ -23,7 +23,7 @@ module ReactManifest
 
       # Record emitted bundles so react_component doesn't re-emit them.
       emitted = (@_react_manifest_emitted_bundles ||= [])
-      bundles.each { |b| emitted << b unless emitted.include?(b) }
+      bundles.each { |b| emitted << b unless emitted_bundle?(emitted, b) }
 
       asset_names = bundles.map { |bundle| "#{bundle}.js" }
       javascript_include_tag(*asset_names, extname: false, **html_options)
@@ -43,7 +43,7 @@ module ReactManifest
       emitted = (@_react_manifest_emitted_bundles ||= [])
 
       new_tags = bundles.filter_map do |bundle|
-        next if emitted.include?(bundle)
+        next if emitted_bundle?(emitted, bundle)
 
         emitted << bundle
         javascript_include_tag("#{bundle}.js", extname: false)
@@ -53,5 +53,16 @@ module ReactManifest
 
       safe_join(new_tags + [html])
     end
+
+    private
+
+    def emitted_bundle?(emitted, bundle)
+      canonical = canonical_bundle_name(bundle)
+      emitted.any? { |existing| canonical_bundle_name(existing) == canonical }
+    end
+
+    def canonical_bundle_name(bundle)
+      bundle.to_s.split("/").last
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: react-manifest-rails
 version: !ruby/object:Gem::Version
-  version: 0.2.20
+  version: 0.2.22
 platform: ruby
 authors:
 - Oliver Noonan