Test installer (#553)

* Test installer

This commit adds test coverage for the installer Rake task and application template. The installer is run against a freshly generated Rails app using the version of Rails that is currently loaded. Thus the installer can be tested with different versions of Rails in CI.

Similar to hotwired/stimulus-rails#136.

The motivation is to be able to move these tests from railties, see: rails/rails#49679

Co-authored-by: Jonathan Hefner <[email protected]>

* Monkey-patch AppName#valid_const? on older Rails (< 7.1)

My hunch is that this was fixed in Rails 7.1 by rails/rails#46074, but I'm less concerned here because this test suite uses a Dummy app for all of the tests.

This is a problem I've been working on in rails/rails#50427, to remove the dummy applications and replace them with a generated app like we've done here with the installer test.

I'm happy to investigate replacing the dummy app here afterwards.

* Make sure only supported sqlite3 gem is installed

```
LoadError: Error loading the 'sqlite3' Active Record adapter. Missing a gem it depends on? can't activate sqlite3 (~> 1.4), already activated sqlite3-2.0.0-x86_64-linux-gnu. Make sure all dependencies are added to Gemfile. (LoadError)

Caused by:
Gem::LoadError: can't activate sqlite3 (~> 1.4), already activated sqlite3-2.0.0-x86_64-linux-gnu. Make sure all dependencies are added to Gemfile. (Gem::LoadError)

Tasks: TOP => db:test:prepare => db:load_config
(See full trace by running task with --trace)
/home/zzak/.rbenv/versions/3.2.3/lib/ruby/gems/3.2.0/gems/bundler-2.5.4/lib/bundler/rubygems_integration.rb:237:in `block (2 levels) in replace_gem': Error loading the 'sqlite3' Active Record adapter. Missing a gem it depends on? can't activate sqlite3 (~> 1.4), already activated sqlite3-2.0.0-x86_64-linux-gnu. Make sure all dependencies are added to Gemfile. (LoadError)
```

* Fix installer test for Rails 6.1

---------

Co-authored-by: Jonathan Hefner <[email protected]>
Co-authored-by: David Heinemeier Hansson <[email protected]>

Author: 3 people

.github/workflows/ci.yml

@@ -34,6 +34,7 @@ jobs:
       - name: Run Bug Template Tests
         run: ruby bug_report_template.rb || ruby bug_report_template.rb
 
+      - uses: oven-sh/setup-bun@v1
       - name: Run tests
         id: test
         run: bundle exec rake TESTOPT=-vdc

test/app_helper.rb

@@ -0,0 +1,53 @@
+require "rails"
+require "rails/test_help"
+require "fileutils"
+
+if Gem::Version.new(Rails.version) < Gem::Version.new("7.1")
+  module Rails::Generators::AppName
+    private
+      def valid_const?
+        true
+      end
+  end
+end
+
+module RailsAppHelpers
+  private
+  def create_new_rails_app(app_dir, options=[])
+    require "rails/generators/rails/app/app_generator"
+    Rails::Generators::AppGenerator.start([app_dir, *options, "--skip-bundle", "--skip-bootsnap", "--quiet"])
+
+    Dir.chdir(app_dir) do
+      gemfile = File.read("Gemfile")
+
+      gemfile.gsub!(/^gem ["']turbo-rails["'].*/, "")
+      gemfile << %(gem "turbo-rails", path: #{File.expand_path("..", __dir__).inspect}\n)
+
+      if Rails::VERSION::PRE == "alpha"
+        gemfile.gsub!(/^gem ["']rails["'].*/, "")
+        gemfile << %(gem "rails", path: #{Gem.loaded_specs["rails"].full_gem_path.inspect}\n)
+      end
+
+      File.write("Gemfile", gemfile)
+
+      run_command("bundle", "install")
+    end
+  end
+
+  def with_new_rails_app(options=[], &block)
+    require "digest/sha1"
+    variant = [RUBY_VERSION, Gem.loaded_specs["rails"].full_gem_path,]
+    app_name = "turbo_test_app_#{Digest::SHA1.hexdigest(variant.to_s)}"
+
+    Dir.mktmpdir do |tmpdir|
+      create_new_rails_app("#{tmpdir}/#{app_name}", *options)
+      Dir.chdir("#{tmpdir}/#{app_name}", &block)
+    end
+  end
+
+  def run_command(*command)
+    Bundler.with_unbundled_env do
+      capture_subprocess_io { system(*command, exception: true) }
+    end
+  end
+end

test/installer_test.rb

@@ -0,0 +1,60 @@
+require 'app_helper'
+
+class InstallerTest < ActiveSupport::TestCase
+  include RailsAppHelpers
+  include ActiveSupport::Testing::Isolation
+
+  test "installer" do
+    with_new_rails_app do
+      if Rails::VERSION::MAJOR >= 7 && File.read("Gemfile").match?(/importmap-rails/)
+        run_command("bin/rails", "importmap:install")
+      end
+      run_command("bin/rails", "turbo:install")
+
+      if Gem::Version.new(Rails.version) >= Gem::Version.new("7.0")
+        assert_match %(import "@hotwired/turbo-rails"\n), File.read("app/javascript/application.js")
+      end
+
+      if Rails::VERSION::MAJOR >= 7
+        assert_match %(pin "@hotwired/turbo-rails", to: "turbo.min.js"), File.read("config/importmap.rb")
+      else
+        assert_match "@hotwired/turbo-rails", File.read("package.json")
+        assert_match "@hotwired/turbo-rails", File.read("yarn.lock")
+      end
+    end
+  end
+
+  test "installer with no javascript" do
+    with_new_rails_app %w[--skip-javascript] do
+      out, = run_command("bin/rails", "turbo:install")
+
+      assert_match "You must either be running with node (package.json) or importmap-rails (config/importmap.rb) to use this gem.", out
+    end
+  end
+
+  test "installer with pre-existing application.js" do
+    with_new_rails_app do
+      if Rails::VERSION::MAJOR >= 7 && File.read("Gemfile").match?(/importmap-rails/)
+        run_command("bin/rails", "importmap:install")
+      end
+      File.write("app/javascript/application.js", "// pre-existing")
+      run_command("bin/rails", "turbo:install")
+
+      assert_match "// pre-existing", File.read("app/javascript/application.js")
+      assert_match %(import "@hotwired/turbo-rails"\n), File.read("app/javascript/application.js")
+    end
+  end
+
+  if Gem::Version.new(Rails.version) >= Gem::Version.new("7.1")
+    test "installer with bun" do
+      with_new_rails_app %w[--javascript=bun] do
+        run_command("bin/rails", "javascript:install:bun")
+        run_command("bin/rails", "turbo:install")
+
+        assert_match %(import "@hotwired/turbo-rails"\n), File.read("app/javascript/application.js")
+
+        assert_match "@hotwired/turbo-rails", File.read("package.json")
+      end
+    end
+  end
+end