opal-rails 2.0.3 → 3.0.0

data/lib/opal/rails/outputs_manifest.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'fileutils'
+require 'pathname'
+require 'tempfile'
+
+module Opal
+  module Rails
+    class OutputsManifest
+      FILE_NAME = '.opal-build-manifest.json'
+
+      def initialize(build_path:)
+        @build_path = Pathname(build_path).expand_path
+      end
+
+      def read_outputs
+        return [] unless manifest_path.exist?
+
+        JSON.parse(manifest_path.read).fetch('outputs')
+      rescue JSON::ParserError, KeyError
+        nil
+      end
+
+      def prune_stale!(current_outputs)
+        previous_outputs = read_outputs
+        return false if previous_outputs.nil?
+
+        stale_outputs(previous_outputs, current_outputs).each do |relative_path|
+          full_path = safe_build_path(relative_path)
+          full_path.delete if full_path&.exist?
+        end
+
+        true
+      end
+
+      def write!(outputs)
+        FileUtils.mkdir_p(build_path)
+
+        Tempfile.create(['opal-build-manifest', '.json'], build_path.to_s) do |file|
+          file.write(JSON.pretty_generate('version' => 1, 'outputs' => outputs.sort))
+          file.flush
+          FileUtils.mv(file.path, manifest_path)
+        end
+      end
+
+      def clobber!
+        outputs = read_outputs
+        return nil if outputs.nil?
+
+        outputs.each do |relative_path|
+          full_path = safe_build_path(relative_path)
+          full_path.delete if full_path&.exist?
+        end
+
+        manifest_path.delete if manifest_path.exist?
+
+        outputs
+      end
+
+      private
+
+      attr_reader :build_path
+
+      def manifest_path
+        build_path.join(FILE_NAME)
+      end
+
+      def stale_outputs(previous_outputs, current_outputs)
+        previous_outputs - current_outputs
+      end
+
+      def safe_build_path(relative_path)
+        full_path = build_path.join(relative_path).expand_path
+        return full_path if full_path.to_s.start_with?(build_path.to_s + File::SEPARATOR) ||
+                            full_path.to_s == build_path.to_s
+
+        nil
+      end
+    end
+  end
+end

data/lib/opal/rails/path_setup.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Opal
+  module Rails
+    module PathSetup
+      module_function
+
+      def apply!(app, autoloaders: ::Rails.autoloaders)
+        app.config.opal.source_path ||= app.root.join('app/opal')
+        app.config.opal.entrypoints_path ||= app.config.opal.source_path
+        app.config.opal.build_path ||= app.root.join('app/assets/builds')
+
+        source_path = Pathname(app.config.opal.source_path).expand_path
+        app_assets_path = app.root.join('app/assets').expand_path
+
+        app.config.eager_load_paths = app.config.eager_load_paths.dup - Dir["#{app.root}/app/{assets,views}"]
+
+        app.config.eager_load_paths -= [source_path.to_s] if source_path.to_s.start_with?(app.root.join('app').to_s)
+
+        return if source_path.to_s.start_with?(app_assets_path.to_s)
+
+        Array(autoloaders).each { |autoloader| autoloader.ignore(source_path) }
+      end
+    end
+  end
+end

data/lib/opal/rails/task_hooks.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+module Opal
+  module Rails
+    module TaskHooks
+      module_function
+
+      BUILD_HOOKS = [
+        'assets:precompile',
+        'test:prepare',
+        'spec:prepare'
+      ].freeze
+
+      # Ensure `rake test` invokes test:prepare (which Rails defines but
+      # does not wire as a prerequisite of the :test task).
+      PREPARE_HOOKS = {
+        'test' => 'test:prepare',
+        'spec' => 'spec:prepare'
+      }.freeze
+
+      CLOBBER_HOOKS = [
+        'assets:clobber'
+      ].freeze
+
+      def apply!(task_manager: Rake::Task)
+        BUILD_HOOKS.each do |task_name|
+          attach(task_name, prerequisite: 'opal:build', task_manager: task_manager)
+        end
+        CLOBBER_HOOKS.each do |task_name|
+          attach(task_name, prerequisite: 'opal:clobber', task_manager: task_manager)
+        end
+        PREPARE_HOOKS.each do |task_name, prerequisite|
+          attach(task_name, prerequisite: prerequisite, task_manager: task_manager)
+        end
+      end
+
+      def attach(task_name, prerequisite:, task_manager: Rake::Task)
+        return unless task_manager.task_defined?(task_name)
+
+        task = task_manager[task_name]
+        return if task.prerequisites.include?(prerequisite)
+
+        task.enhance([prerequisite])
+      end
+    end
+  end
+end

data/lib/opal/rails/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Rails
-    VERSION = '2.0.3'
+    VERSION = '3.0.0'
   end
 end

data/lib/opal/rails/watch_runner.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+module Opal
+  module Rails
+    class WatchRunner
+      def initialize(config:, resolver: nil, builder_runner: nil, manifest: nil, file_watcher_class: FileWatcher,
+                     output: $stdout, error_output: $stderr, kernel: Kernel)
+        @config = config
+        @resolver = resolver
+        @builder_runner = builder_runner
+        @manifest = manifest
+        @file_watcher_class = file_watcher_class
+        @output = output
+        @error_output = error_output
+        @kernel = kernel
+        @dependencies_by_entrypoint = {}
+        @outputs_by_entrypoint = {}
+        @reverse_dependencies = Hash.new { |hash, key| hash[key] = [] }
+        @opal_dependencies = []
+      end
+
+      def watch
+        start!
+        output.puts '* Opal watcher started'
+        kernel.sleep
+      rescue Interrupt
+        output.puts '* Stopping Opal watcher...'
+      ensure
+        watcher&.stop
+      end
+
+      def start!
+        rebuild_all!
+      end
+
+      def process_changes(modified:, added:, removed:)
+        modified = normalize_paths(modified)
+        added = normalize_paths(added)
+        removed = normalize_paths(removed)
+        changed = (modified + added + removed).uniq.sort
+        return if changed.empty?
+
+        if full_rebuild_required?(changed: changed, modified: modified, added: added, removed: removed)
+          error_output.puts "* Modified code: #{changed.join(', ')}; rebuilding all entrypoints"
+          rebuild_all!
+        else
+          logical_names = modified.flat_map { |path| reverse_dependencies[path] }.uniq.sort
+          return if logical_names.empty?
+
+          error_output.puts "* Modified code: #{modified.join(', ')}; rebuilding #{logical_names.join(', ')}"
+          rebuild_entrypoints!(logical_names)
+        end
+      end
+
+      private
+
+      attr_reader :builder_runner, :config, :error_output, :file_watcher_class, :kernel, :manifest, :opal_dependencies,
+                  :output, :resolved_entrypoints, :resolver, :reverse_dependencies
+      attr_accessor :watcher
+
+      def rebuild_all!
+        @resolved_entrypoints = current_resolver.resolve
+        result = current_builder_runner.build(entrypoints: resolved_entrypoints)
+
+        @dependencies_by_entrypoint = normalize_dependency_map(result.fetch(:dependencies))
+        @outputs_by_entrypoint = resolved_entrypoints.each_with_object({}) do |(logical_name, _), outputs|
+          outputs[logical_name] = outputs_for(logical_name)
+        end
+
+        current_manifest.prune_stale!(owned_outputs)
+        current_manifest.write!(owned_outputs)
+        refresh_watcher!
+      rescue StandardError => e
+        error_output.puts "* Opal build error: #{e.message}"
+        refresh_watcher! if @resolved_entrypoints
+      end
+
+      def rebuild_entrypoints!(logical_names)
+        entrypoints = resolved_entrypoints.slice(*logical_names)
+        result = current_builder_runner.build(entrypoints: entrypoints)
+
+        normalize_dependency_map(result.fetch(:dependencies)).each_pair do |logical_name, files|
+          @dependencies_by_entrypoint[logical_name] = files
+        end
+
+        current_manifest.write!(owned_outputs)
+        refresh_watcher!
+      rescue StandardError => e
+        error_output.puts "* Opal build error: #{e.message}"
+      end
+
+      def refresh_watcher!
+        @opal_dependencies = normalize_paths(Opal.dependent_files)
+        rebuild_reverse_dependencies!
+
+        watcher&.stop
+        self.watcher = file_watcher_class.new(files: watched_files,
+                                              extra_directories: extra_directories) do |modified:, added:, removed:|
+          process_changes(modified: modified, added: added, removed: removed)
+        end
+        watcher.start
+      end
+
+      def rebuild_reverse_dependencies!
+        @reverse_dependencies = Hash.new { |hash, key| hash[key] = [] }
+
+        @dependencies_by_entrypoint.each_pair do |logical_name, files|
+          files.each { |path| @reverse_dependencies[path] << logical_name }
+        end
+      end
+
+      def watched_files
+        (opal_dependencies + @dependencies_by_entrypoint.values.flatten).uniq.sort
+      end
+
+      def owned_outputs
+        @outputs_by_entrypoint.values.flatten.uniq.sort
+      end
+
+      def outputs_for(logical_name)
+        outputs = ["#{logical_name}.js"]
+        outputs << "#{logical_name}.js.map" if source_map_enabled?
+        outputs
+      end
+
+      def full_rebuild_required?(changed:, modified:, added:, removed:)
+        return true unless (changed & opal_dependencies).empty?
+        return true unless added.empty? && removed.empty?
+        return true if modified.any? { |path| reverse_dependencies[path].empty? }
+
+        false
+      end
+
+      def source_map_enabled?
+        value = config[:source_map_enabled]
+        value.nil? ? Opal::Config.source_map_enabled : value
+      end
+
+      def extra_directories
+        directories = [config.source_path, *Array(config.append_paths)]
+        directories << config.entrypoints_path if config.entrypoints == :all
+        normalize_paths(directories)
+      end
+
+      def current_resolver
+        @resolver ||= EntrypointsResolver.new(
+          entrypoints_path: config.entrypoints_path,
+          entrypoints: config.entrypoints
+        )
+      end
+
+      def current_builder_runner
+        @builder_runner ||= BuilderRunner.new(config: config)
+      end
+
+      def current_manifest
+        @manifest ||= OutputsManifest.new(build_path: config.build_path)
+      end
+
+      def normalize_dependency_map(dependencies)
+        dependencies.each_with_object({}) do |(logical_name, files), normalized|
+          normalized[logical_name] = normalize_paths(files)
+        end
+      end
+
+      def normalize_paths(paths)
+        Array(paths).map { |path| Pathname(path).expand_path.to_s }.uniq.sort
+      end
+    end
+  end
+end

data/lib/opal/rails.rb

@@ -1,5 +1,12 @@
 require 'opal'
 
+require 'opal/rails/errors'
+require 'opal/rails/entrypoints_resolver'
+require 'opal/rails/builder_runner'
+require 'opal/rails/outputs_manifest'
+require 'opal/rails/legacy_upgrade_warning'
+require 'opal/rails/path_setup'
+require 'opal/rails/task_hooks'
 require 'opal/rails/engine'
 require 'opal/rails/template_handler'
 require 'opal/rails/version'

data/lib/tasks/opal.rake

@@ -0,0 +1,48 @@
+namespace :opal do
+  desc 'Build configured Opal entrypoints into app/assets/builds'
+  task build: :environment do
+    app_config = Rails.application.config.opal
+
+    resolver = Opal::Rails::EntrypointsResolver.new(
+      entrypoints_path: app_config.entrypoints_path,
+      entrypoints: app_config.entrypoints
+    )
+    entrypoints = resolver.resolve
+
+    runner = Opal::Rails::BuilderRunner.new(config: app_config)
+    result = runner.build(entrypoints: entrypoints)
+
+    manifest = Opal::Rails::OutputsManifest.new(build_path: app_config.build_path)
+    manifest.prune_stale!(result[:outputs])
+    manifest.write!(result[:outputs])
+
+    if result[:outputs].empty?
+      puts 'Built 0 Opal assets'
+    else
+      puts "Built Opal assets: #{result[:outputs].join(', ')}"
+    end
+  end
+
+  desc 'Remove Opal-owned build outputs from app/assets/builds'
+  task clobber: :environment do
+    manifest = Opal::Rails::OutputsManifest.new(build_path: Rails.application.config.opal.build_path)
+    removed_outputs = manifest.clobber!
+
+    if removed_outputs.nil?
+      warn 'Skipped Opal clobber because the build manifest is unreadable'
+    elsif removed_outputs.empty?
+      puts 'Removed 0 Opal assets'
+    else
+      puts "Removed Opal assets: #{removed_outputs.join(', ')}"
+    end
+  end
+
+  desc 'Watch configured Opal entrypoints and rebuild on change'
+  task watch: :environment do
+    require 'opal/rails/file_watcher'
+    require 'opal/rails/watch_runner'
+    Opal::Rails::WatchRunner.new(config: Rails.application.config.opal).watch
+  end
+end
+
+Opal::Rails::TaskHooks.apply!

data/opal-rails.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors     = ['Elia Schito']
   spec.email       = ['elia@schito.me']
 
-  spec.summary     = %q{Rails bindings for opal JS engine}
-  spec.description = %q{Rails bindings for opal JS engine}
+  spec.summary     = 'Rails bindings for opal JS engine'
+  spec.description = 'Rails bindings for opal JS engine'
   spec.homepage    = 'https://github.com/opal/opal-rails#readme'
   spec.license     = 'MIT-LICENSE'
 
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.metadata['source_code_uri'] = 'https://github.com/opal/opal-rails#readme'
   spec.metadata['changelog_uri'] = 'https://github.com/opal/opal-rails/blob/master/CHANGELOG.md'
 
-  spec.required_ruby_version = Gem::Requirement.new('>= 2.5')
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.7')
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -25,24 +25,33 @@ Gem::Specification.new do |spec|
 
   spec.files = files.grep_v(%r{^(test|spec|features)/})
   spec.test_files = files.grep(%r{^(test|spec|features)/})
-  spec.bindir = "exe"
+  spec.bindir = 'exe'
   spec.executables = files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_dependency 'rails',               '>= 6.0', '< 7.1'
-  spec.add_dependency 'sprockets-rails',     '>= 3.0'
+  spec.add_dependency 'rails',               '>= 7.0', '< 8.2'
 
-  spec.add_dependency 'opal',                '~> 1.0'
-  spec.add_dependency 'opal-sprockets',      '~> 1.0'
+  spec.add_dependency 'opal',                '>= 1.7.0'
 
-  spec.add_development_dependency 'haml'
+  spec.add_dependency 'listen',              '>= 3.0'
 
-  spec.add_development_dependency 'execjs'
-  spec.add_development_dependency 'launchy'
+  spec.add_development_dependency 'haml', '>= 6'
+
+  spec.add_development_dependency 'appraisal', '~> 2.1'
+  spec.add_development_dependency 'base64'
+  spec.add_development_dependency 'benchmark'
+  spec.add_development_dependency 'bigdecimal'
   spec.add_development_dependency 'capybara', '~> 3.25'
+  spec.add_development_dependency 'cgi'
   spec.add_development_dependency 'cuprite'
+  spec.add_development_dependency 'execjs'
+  spec.add_development_dependency 'launchy'
+  spec.add_development_dependency 'logger'
+  spec.add_development_dependency 'mutex_m'
+  spec.add_development_dependency 'ostruct'
+  spec.add_development_dependency 'puma'
   spec.add_development_dependency 'rspec-rails'
-  spec.add_development_dependency 'appraisal', '~> 2.1'
+  spec.add_development_dependency 'sprockets-rails', '>= 3.0'
   spec.add_development_dependency 'sqlite3'
-  spec.add_development_dependency 'puma'
+  spec.add_development_dependency 'tsort'
 end