opal-rails 2.0.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e906bb39e61bd1c76e195bcb8a26ea06864ea268564bae806fde7e516b7dea4b
-  data.tar.gz: 78d2469ab085763e2d5f9e35ad78544907dc44842bd4e173cfbb356811b9dcfc
+  metadata.gz: ba1f394cc2bbf7116233984024e784413beafbaf854ecec344dd4ac82b3399c5
+  data.tar.gz: aeb984c344f373496ee3ab1ec65b25b98941a8f3abd8cb90f2798f0f76557bdb
 SHA512:
-  metadata.gz: 07a8fb5f8d174eb6ea19489d6c758f1f0356b70312b5f7fed2958206fe12fbe18c8833dce05b403fde12b81d169fefdead8dc1c7e867e4f1fbace13f197f4b0c
-  data.tar.gz: 33049701172699ca92284856854600b89b6ae307088d79f4e4fc1c7a8d61aed3138ca05ed3608835dec86b37669fa97fa5225722e6810c27935dd8ed8e7731c5
+  metadata.gz: f1c3651233c6b59f85c924cfca5eae702ff796ac152328e2166407e3cacfcb911b5b2485149832f8a906744c3c979b86ee72ef217922efb40cbd2d4ffe3096b7
+  data.tar.gz: 143ec8db4639e589f5d4cda0c9b8b4fa9ee93ab26fcb9e5909918093f0be5f26b3b9152be48492a43500d2454d459a35af6d8a734a08913b5e82d3c839b83f37

data/.github/workflows/build.yml

@@ -13,9 +13,43 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ['3.0', '3.1', '3.2']
-        rails: ['rails_6_0', 'rails_6_1', 'rails_7_0']
-        opal: ['opal_1_0', 'opal_1_3', 'opal_1_7']
+        include:
+          - ruby: '3.2'
+            rails: 'rails_7_0'
+            opal: 'opal_1_8'
+          - ruby: '3.2'
+            rails: 'rails_7_0'
+            opal: 'opal_master'
+          - ruby: '4.0'
+            rails: 'rails_7_0'
+            opal: 'opal_1_8'
+          - ruby: '4.0'
+            rails: 'rails_7_0'
+            opal: 'opal_master'
+          - ruby: '3.2'
+            rails: 'rails_8_0'
+            opal: 'opal_1_8'
+          - ruby: '3.2'
+            rails: 'rails_8_0'
+            opal: 'opal_master'
+          - ruby: '4.0'
+            rails: 'rails_8_0'
+            opal: 'opal_1_8'
+          - ruby: '4.0'
+            rails: 'rails_8_0'
+            opal: 'opal_master'
+          - ruby: '3.2'
+            rails: 'rails_8_1'
+            opal: 'opal_1_8'
+          - ruby: '3.2'
+            rails: 'rails_8_1'
+            opal: 'opal_master'
+          - ruby: '4.0'
+            rails: 'rails_8_1'
+            opal: 'opal_1_8'
+          - ruby: '4.0'
+            rails: 'rails_8_1'
+            opal: 'opal_master'
     runs-on: ubuntu-latest
 
     steps:
@@ -23,7 +57,8 @@ jobs:
       run: |
         sudo apt-get update
         sudo apt-get install -y sqlite3 libsqlite3-dev
-    - uses: actions/checkout@v1
+        command -v google-chrome || command -v google-chrome-stable || command -v chromium-browser || command -v chromium || sudo apt-get install -y chromium-browser || sudo apt-get install -y chromium
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:

data/.gitignore

@@ -7,6 +7,8 @@
 /test_apps/log/*.log
 /test_apps/tmp/
 /test_apps/.sass-cache
+/test_apps/app/assets/builds/*
+!/test_apps/app/assets/builds/.keep
 Gemfile.lock
 *.gemfile.lock
 

data/Appraisals

@@ -1,40 +1,39 @@
 current_ruby = Gem::Version.new(RUBY_VERSION)
-ruby_2_5_0 = Gem::Version.new('2.5.0')
 ruby_2_7_0 = Gem::Version.new('2.7.0')
+ruby_3_2_0 = Gem::Version.new('3.2.0')
+
+rails_7_sqlite3 = '~> 1.4'
+rails_8_sqlite3 = '>= 2.1'
 
 ENV['OPAL_VERSION'] = nil # ensure the env is clean
 
 github = -> repo_name { "https://github.com/#{repo_name}.git" }
 
 {
-  opal_1_7: -> gemfile do
-    gemfile.gem 'opal', '~> 1.7.0'
-    gemfile.gem 'opal-sprockets'
-  end,
-
-  opal_1_3: -> gemfile do
-    gemfile.gem 'opal', '~> 1.3.0'
-    gemfile.gem 'opal-sprockets'
+  opal_1_8: -> gemfile do
+    gemfile.gem 'opal', '~> 1.8.0'
   end,
 
-  opal_1_0: -> gemfile do
-    gemfile.gem 'opal', '~> 1.0.0'
-    gemfile.gem 'opal-sprockets'
+  opal_master: -> gemfile do
+    gemfile.gem 'opal', git: github['opal/opal'], branch: :master
   end,
 
 }.each do |opal_version, gem_opal|
-  appraise "rails_6_0_#{opal_version}" do
-    gem "rails", "~> 6.0.0"
+  appraise "rails_7_0_#{opal_version}" do
+    gem "rails", "~> 7.0.0"
+    gem 'sqlite3', rails_7_sqlite3
     gem_opal[self]
-  end if current_ruby >= ruby_2_5_0
+  end if current_ruby >= ruby_2_7_0
 
-  appraise "rails_6_1_#{opal_version}" do
-    gem "rails", "~> 6.1.0"
+  appraise "rails_8_0_#{opal_version}" do
+    gem "rails", "~> 8.0.0"
+    gem 'sqlite3', rails_8_sqlite3
     gem_opal[self]
-  end if current_ruby >= ruby_2_5_0
+  end if current_ruby >= ruby_3_2_0
 
-  appraise "rails_7_0_#{opal_version}" do
-    gem "rails", "~> 7.0.0"
+  appraise "rails_8_1_#{opal_version}" do
+    gem "rails", "~> 8.1.0"
+    gem 'sqlite3', rails_8_sqlite3
     gem_opal[self]
-  end if current_ruby >= ruby_2_7_0
+  end if current_ruby >= ruby_3_2_0
 end

data/CHANGELOG.md

@@ -18,6 +18,36 @@ Whitespace conventions:
 - 1 spaces before normal text
  -->
 
+## [Unreleased]
+
+## [3.0.0](https://github.com/opal/opal-rails/compare/v2.0.4...v3.0.0) - 2026-04-09
+
+### Added
+
+- Add build-based Opal compilation with `opal:build`.
+- Add `opal:clobber` for Opal-owned build outputs.
+- Add dependency-aware `opal:watch`.
+
+### Changed
+
+- Rework `opal:install` for build-based apps and migration-friendly layouts.
+- Make Sprockets optional at runtime.
+- Make `opal:assets` generate `.rb` files in the active Opal source root.
+- Update the sandbox flow to run an initial `opal:build`.
+- Drop Rails 6.x support and require Ruby 2.7+.
+- Add Rails 8.0 and 8.1 support.
+- Require Opal 1.7+ and move the active matrix to Opal 1.8.
+- Add Opal master coverage and focus CI on Ruby 3.2 and 4.0.
+- Require Haml 6+ for the optional `:opal` filter.
+
+### Removed
+
+- Remove helper-side Opal loader integration and Sprockets path injection.
+
+### Fixed
+
+- Stabilize browser-driven specs on Ruby 4.
+
 ## [2.0.4](https://github.com/opal/opal-rails/compare/v2.0.3...v2.0.4) - 2024-12-06
 
 ### Added

data/Gemfile

@@ -6,11 +6,11 @@ case ENV['OPAL_VERSION']
 when 'local'
   gem 'opal', path: '../opal'
   gem 'opal-rspec', path: '../opal-rspec'
-  gem 'opal-sprockets', path: '../opal-sprockets'
   gem 'pry'
 when 'master'
   gem 'opal', git: github['opal/opal'], branch: :master
-  gem 'opal-sprockets', git: github['opal/opal-sprockets'], branch: :master
 end
 
 gem 'net-smtp'
+
+gem "gem-release", "~> 2.2"

data/PORTING.md

@@ -0,0 +1,140 @@
+# Porting opal-rails 2.x to 3.x
+
+`opal-rails` 3.x drops the old Sprockets-era Opal pipeline and moves Opal assets to an explicit build step.
+
+## What changes
+
+- Opal source files are built into `app/assets/builds`
+- `opal:build` replaces request-time Opal compilation
+- `opal:watch` replaces the old edit-refresh flow for development
+- `manifest.js` should link built assets, not raw Opal source files
+- old `Opal.use_gem` / `Opal.append_path` setup in `config/initializers/assets.rb` should move to `config/initializers/opal.rb`
+
+## Fast path
+
+For a fresh install, or for an app you are intentionally reshaping into the 3.x build layout in one pass, you can run:
+
+```bash
+bin/rails g opal:install
+```
+
+Do not treat that generator as a safe in-place upgrade for an existing 2.x app that already has legacy Opal assets wired in. In a real Rails 7 `2.0.4 -> 3.x` upgrade repro, it layered 3.x files on top of the old setup and still left the app in a broken state. For those apps, pin `opal-rails` to the `2.0` series until you can port deliberately, or follow the manual checklist below.
+
+The generator now:
+
+- creates `config/initializers/opal.rb` with build-based defaults
+- creates `app/assets/builds/.keep`
+- links `app/assets/builds` from `app/assets/config/manifest.js` when that file exists
+- sets `config.assets.debug = true` in `config/environments/test.rb` when that file exists so tests prefer freshly rebuilt assets over stale checked-in digests
+- creates or updates `Procfile.dev` with `opal: bin/rails opal:watch`
+- creates `bin/dev` when missing, or replaces an existing `bin/dev` that does not reference `Procfile.dev` (Rails 8.1+ generates a `bin/dev` that just execs `rails server`); the generated launcher installs `foreman` if needed and runs `Procfile.dev`
+
+## Manual migration checklist
+
+1. Move your Opal entrypoints to either:
+   - `app/opal` for a greenfield-style layout, or
+   - `app/assets/opal` for a migration-friendly layout
+2. Configure Opal in `config/initializers/opal.rb`.
+
+For a single entrypoint:
+
+```ruby
+Rails.application.configure do
+  config.opal.source_path = Rails.root.join("app/opal")
+  config.opal.entrypoints_path = config.opal.source_path
+  config.opal.entrypoints = { "application" => "application.rb" }
+  config.opal.use_gems = []
+end
+```
+
+For multi-entrypoint apps that keep Opal files under `app/assets/opal`:
+
+```ruby
+Rails.application.configure do
+  config.opal.source_path = Rails.root.join("app/assets/opal")
+  config.opal.entrypoints_path = config.opal.source_path
+  config.opal.entrypoints = :all
+  config.opal.use_gems = %w[some-gem]
+end
+```
+
+If you keep Opal sources under `app/assets/opal`, take care of asset serving explicitly: `opal-rails` no longer hides that directory from the host asset pipeline for you.
+
+- Propshaft apps should add an exclusion when they would otherwise serve or fingerprint raw files from `app/assets/opal`:
+
+```ruby
+config.assets.excluded_paths << Rails.root.join("app/assets/opal")
+```
+
+- Sprockets apps should make sure `app/assets/config/manifest.js` links only `app/assets/builds`, and should remove old raw-source links such as `link_tree ../opal`, `link_directory ../opal`, `require_tree`, or other directives that expose `app/assets/opal` directly.
+
+You only need that extra asset-pipeline care when you keep the migration-friendly `app/assets/opal` layout. The default `app/opal` layout stays outside the asset load path, so there is nothing extra to exclude.
+
+3. Remove old Opal load-path setup from `config/initializers/assets.rb`, such as:
+
+```ruby
+Opal.use_gem "some-gem"
+Opal.append_path Rails.root.join("app", "assets", "opal")
+```
+
+and move it into `config.opal.use_gems` / `config.opal.append_paths`.
+
+4. Update `app/assets/config/manifest.js` to link built outputs instead of raw Opal source files:
+
+```js
+//= link_directory ../builds .js
+//= link_directory ../builds .map
+```
+
+If you do not want production builds to generate and serve Opal source maps, disable them in `config/environments/production.rb`:
+
+```ruby
+config.opal.source_map_enabled = false
+```
+
+That keeps the shared manifest configuration intact while stopping `opal:build` / `assets:precompile` from emitting `app/assets/builds/*.js.map` in production.
+
+5. Build assets explicitly (one-off check):
+
+```bash
+bin/rails opal:build
+```
+
+In practice you rarely need to run this manually — `opal-rails` wires `opal:build` into the standard Rake lifecycle automatically (see below).
+
+6. Include the built asset in your layout with the normal Rails helper:
+
+```erb
+<%= javascript_include_tag "application", "data-turbo-track": "reload" %>
+```
+
+or use your own logical asset name if the app already has a different `application.js`.
+
+## Development and test
+
+### Development
+
+The recommended flow is `bin/dev`, which uses Foreman to run both the Rails server and `opal:watch` together via `Procfile.dev`. If you prefer to run processes separately, start `bin/rails opal:watch` in a second terminal while editing Opal files.
+
+### Test
+
+`opal-rails` hooks `opal:build` into these Rake tasks automatically:
+
+| Trigger | How it works |
+|---|---|
+| `rake assets:precompile` | `opal:build` runs first (production deploys) |
+| `rake assets:clobber` | `opal:clobber` cleans build outputs |
+| `rake test` / `rake spec` | `test:prepare` (or `spec:prepare`) runs first, which triggers `opal:build` |
+| `bin/rails test` | Rails' built-in `test:prepare` triggers `opal:build` |
+
+This means `rake test` and `bin/rails test` both rebuild Opal assets before tests run. You should not need to run `opal:build` manually before running tests.
+
+If your repo keeps old checked-in `public/assets` digests, set `config.assets.debug = true` in `config/environments/test.rb` so system tests resolve the rebuilt files from `app/assets/builds` instead of stale manifest entries.
+
+## What to remove from old 2.x apps
+
+- request-time Opal compilation assumptions
+- `app/assets/javascripts/*.js.rb` as the primary entrypoint pattern
+- raw Opal source links in `manifest.js`
+- helper-side Sprockets loader assumptions
+- `opal-sprockets`-specific setup