react-manifest-rails 0.1.0

data/lib/react_manifest/watcher.rb

@@ -0,0 +1,74 @@
+module ReactManifest
+  # Watches the ux/ directory tree for file changes and triggers
+  # manifest regeneration automatically.
+  #
+  # Uses the `listen` gem (soft dependency — degrades gracefully if not available).
+  # Auto-started in development via the Railtie initializer.
+  #
+  # Watches ux_root recursively so newly added controller directories are
+  # picked up without a server restart.
+  module Watcher
+    DEBOUNCE_SECONDS = 0.3
+
+    class << self
+      def start(config = ReactManifest.configuration)
+        begin
+          require "listen"
+        rescue LoadError
+          log "listen gem not available — file watching disabled. " \
+              "Add `gem 'listen'` to the development group in your Gemfile."
+          return
+        end
+
+        root = config.abs_ux_root
+
+        unless Dir.exist?(root)
+          log "ux_root does not exist (#{root}) — file watching disabled until directory is created."
+          return
+        end
+
+        log "Watching #{root.sub(Rails.root.to_s + '/', '')} for changes..."
+
+        @listener = Listen.to(
+          root,
+          only:    /\.(js|jsx)$/,
+          latency: DEBOUNCE_SECONDS
+        ) do |modified, added, removed|
+          changed = (modified + added + removed).map { |f| File.basename(f) }
+          log "File change detected: #{changed.join(', ')}"
+          regenerate!(config)
+        end
+
+        @listener.start
+      end
+
+      def stop
+        @listener&.stop
+        @listener = nil
+      end
+
+      def running?
+        !@listener.nil?
+      end
+
+      private
+
+      def regenerate!(config)
+        Generator.new(config).run!
+        log "Manifests regenerated"
+      rescue => e
+        log "Error during regeneration: #{e.message}"
+        log e.backtrace.first(5).join("\n") if config.verbose?
+      end
+
+      def log(message)
+        msg = "[ReactManifest] #{message}"
+        if defined?(Rails) && Rails.logger
+          Rails.logger.info(msg)
+        else
+          $stdout.puts msg
+        end
+      end
+    end
+  end
+end

data/lib/react_manifest.rb

@@ -0,0 +1,83 @@
+require "set"
+require "fileutils"
+
+require "react_manifest/version"
+require "react_manifest/configuration"
+require "react_manifest/tree_classifier"
+require "react_manifest/scanner"
+require "react_manifest/dependency_map"
+require "react_manifest/generator"
+require "react_manifest/application_analyzer"
+require "react_manifest/application_migrator"
+require "react_manifest/watcher"
+require "react_manifest/reporter"
+require "react_manifest/view_helpers"
+
+module ReactManifest
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+
+    def reset!
+      @configuration = nil
+    end
+
+    # Returns the ordered list of bundle logical names for a given controller.
+    # Used by the react_bundle_tag view helper.
+    def resolve_bundles(ctrl_name)
+      config  = configuration
+      output  = config.abs_output_dir
+      bundles = []
+
+      # 1. Shared bundle always first
+      if bundle_exists?(output, config.shared_bundle)
+        bundles << config.shared_bundle
+      end
+
+      # 2. always_include bundles (e.g. ux_main)
+      config.always_include.each do |b|
+        bundles << b if bundle_exists?(output, b) && !bundles.include?(b)
+      end
+
+      # 3. Controller-specific bundle
+      # Try fully-namespaced first: admin/users → ux_admin_users
+      # Then drop segments: ux_admin
+      controller_candidates(ctrl_name).each do |candidate|
+        if bundle_exists?(output, candidate) && !bundles.include?(candidate)
+          bundles << candidate
+          break
+        end
+      end
+
+      bundles
+    end
+
+    private
+
+    def bundle_exists?(output_dir, bundle_name)
+      File.exist?(File.join(output_dir, "#{bundle_name}.js"))
+    end
+
+    def controller_candidates(ctrl_name)
+      # "admin/reports/summary" → ["ux_admin_reports_summary", "ux_admin_reports", "ux_admin", "ux_summary"]
+      parts = ctrl_name.to_s.split("/")
+      candidates = []
+
+      # Longest match first (most specific)
+      parts.length.downto(1) do |len|
+        candidates << "ux_#{parts.first(len).join('_')}"
+      end
+
+      # Also try just the last segment (common Rails pattern)
+      last = parts.last
+      candidates << "ux_#{last}" unless candidates.include?("ux_#{last}")
+
+      candidates.uniq
+    end
+  end
+end

data/lib/react_manifest_rails.rb

@@ -0,0 +1,2 @@
+require "react_manifest"
+require "react_manifest/railtie" if defined?(Rails)

data/tasks/react_manifest.rake

@@ -0,0 +1,89 @@
+namespace :react_manifest do
+  desc "Generate all ux_*.js Sprockets manifests from the ux/ directory tree"
+  task generate: :environment do
+    results = ReactManifest::Generator.new.run!
+
+    written   = results.count { |r| r[:status] == :written }
+    unchanged = results.count { |r| r[:status] == :unchanged }
+    skipped   = results.count { |r| r[:status] == :skipped_pinned }
+    dry       = results.count { |r| r[:status] == :dry_run }
+
+    if ReactManifest.configuration.dry_run?
+      puts "[ReactManifest] DRY-RUN complete: #{dry} manifest(s) would be written"
+    else
+      puts "[ReactManifest] Done: #{written} written, #{unchanged} unchanged, #{skipped} skipped"
+    end
+
+    # Print any scanner warnings
+    results  # warnings are printed inline by scanner via $stdout in verbose mode
+  end
+
+  desc "Print the JSX dependency map and warnings without writing any files"
+  task analyze: :environment do
+    config     = ReactManifest.configuration
+    classifier = ReactManifest::TreeClassifier.new(config)
+    scanner    = ReactManifest::Scanner.new(config)
+
+    classification = classifier.classify
+    scan_result    = scanner.scan(classification)
+    dep_map        = ReactManifest::DependencyMap.new(scan_result)
+    dep_map.print_report
+
+    unless scan_result.warnings.empty?
+      puts "Warnings (#{scan_result.warnings.size}):"
+      scan_result.warnings.each { |w| puts "  ⚠  #{w}" }
+      puts
+    end
+  end
+
+  desc "Analyze application*.js files — show what migrate_application would change"
+  task analyze_application: :environment do
+    analyzer = ReactManifest::ApplicationAnalyzer.new
+    results  = analyzer.analyze
+    analyzer.print_report(results)
+  end
+
+  desc "Rewrite application*.js files to remove UX code (creates .bak backups)"
+  task migrate_application: :environment do
+    migrator = ReactManifest::ApplicationMigrator.new
+    migrator.migrate!
+  end
+
+  desc "Print per-bundle raw and gzip sizes from compiled public/assets/"
+  task report: :environment do
+    ReactManifest::Reporter.new.report
+  end
+
+  desc "Remove all AUTO-GENERATED ux_*.js manifests"
+  task clean: :environment do
+    config    = ReactManifest.configuration
+    output    = config.abs_output_dir
+    removed   = 0
+    skipped   = 0
+
+    Dir.glob(File.join(output, "ux_*.js")).each do |file|
+      first_line = File.foreach(file).first.to_s
+      if first_line.include?("AUTO-GENERATED")
+        File.delete(file)
+        puts "[ReactManifest] Removed: #{file.sub(Rails.root.to_s + '/', '')}"
+        removed += 1
+      else
+        puts "[ReactManifest] Skipped (not auto-generated): #{file.sub(Rails.root.to_s + '/', '')}"
+        skipped += 1
+      end
+    end
+
+    puts "[ReactManifest] Clean complete: #{removed} removed, #{skipped} skipped"
+  end
+
+  desc "Start the file watcher in the foreground (for debugging)"
+  task watch: :environment do
+    puts "[ReactManifest] Starting file watcher (Ctrl-C to stop)..."
+    ReactManifest::Watcher.start(ReactManifest.configuration)
+    # Block the process
+    sleep
+  rescue Interrupt
+    ReactManifest::Watcher.stop
+    puts "\n[ReactManifest] Watcher stopped."
+  end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: react-manifest-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oliver Noonan
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  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
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |
+  react-manifest-rails automatically generates per-controller Sprockets manifest
+  files for Rails applications using react-rails + Sprockets. It eliminates the
+  monolithic application.js by creating lean, controller-specific ux_*.js bundles,
+  watches for file changes in development, and provides a smart react_bundle_tag
+  view helper that auto-selects the correct bundle per controller.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- README.md
+- lib/react_manifest.rb
+- lib/react_manifest/application_analyzer.rb
+- lib/react_manifest/application_migrator.rb
+- lib/react_manifest/configuration.rb
+- lib/react_manifest/dependency_map.rb
+- lib/react_manifest/generator.rb
+- lib/react_manifest/railtie.rb
+- lib/react_manifest/reporter.rb
+- lib/react_manifest/scanner.rb
+- lib/react_manifest/tree_classifier.rb
+- lib/react_manifest/version.rb
+- lib/react_manifest/view_helpers.rb
+- lib/react_manifest/watcher.rb
+- lib/react_manifest_rails.rb
+- tasks/react_manifest.rake
+homepage: https://github.com/olivernoonan/react-manifest-rails
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/olivernoonan/react-manifest-rails
+  source_code_uri: https://github.com/olivernoonan/react-manifest-rails
+  changelog_uri: https://github.com/olivernoonan/react-manifest-rails/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.19
+signing_key:
+specification_version: 4
+summary: Zero-touch Sprockets manifest generation for react-rails apps
+test_files: []