Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test installer #136

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ jobs:
'6.0.0',
'6.1.0',
'7.0.1',
'7.1.2'
]
ruby: [
'2.7',
Expand All @@ -36,6 +37,7 @@ jobs:
ruby-version: ${{ matrix.ruby }}
bundler-cache: false

- uses: oven-sh/setup-bun@v1
- name: Install Dependencies
env:
RAILS_VERSION: ${{ matrix.rails }}
Expand Down
79 changes: 79 additions & 0 deletions test/installer_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
require 'test_helper'

class InstallerTest < ActiveSupport::TestCase
include RailsAppHelpers

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
_out, _err = run_command("bin/rails", "stimulus:install")

assert_match %r(import "(./)?controllers"), File.read("app/javascript/application.js")
assert_equal File.read("#{__dir__}/../lib/install/app/javascript/controllers/application.js"), File.read("app/javascript/controllers/application.js")
assert_equal File.read("#{__dir__}/../lib/install/app/javascript/controllers/hello_controller.js"), File.read("app/javascript/controllers/hello_controller.js")

if Rails::VERSION::MAJOR >= 7
assert_equal File.read("#{__dir__}/../lib/install/app/javascript/controllers/index_for_importmap.js"), File.read("app/javascript/controllers/index.js")
assert_match %(pin "@hotwired/stimulus", to: "stimulus.min.js"), File.read("config/importmap.rb")
assert_match %(pin "@hotwired/stimulus-loading", to: "stimulus-loading.js"), File.read("config/importmap.rb")
assert_match %(pin_all_from "app/javascript/controllers", under: "controllers"), File.read("config/importmap.rb")
else
assert_equal File.read("#{__dir__}/../lib/install/app/javascript/controllers/index_for_node.js"), File.read("app/javascript/controllers/index.js")
assert_match "@hotwired/stimulus", File.read("package.json")
assert_match "@hotwired/stimulus", File.read("yarn.lock")
end
end
end

test "installer with no javascript" do
with_new_rails_app %w[--skip-javascript] do
out, _err = run_command("bin/rails", "stimulus: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")
_out, _err = run_command("bin/rails", "stimulus:install")

assert_match "// pre-existing", 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")
_out, _err = run_command("bin/rails", "stimulus:install")

assert_match %r(import "(./)?controllers"), File.read("app/javascript/application.js")
assert_equal File.read("#{__dir__}/../lib/install/app/javascript/controllers/application.js"), File.read("app/javascript/controllers/application.js")
assert_equal File.read("#{__dir__}/../lib/install/app/javascript/controllers/hello_controller.js"), File.read("app/javascript/controllers/hello_controller.js")

assert_equal File.read("#{__dir__}/../lib/install/app/javascript/controllers/index_for_node.js"), File.read("app/javascript/controllers/index.js")

assert_match "@hotwired/stimulus", File.read("package.json")
end
end
end

private
def with_new_rails_app(options=[], &block)
super do
if Dir.exist?("app/javascript") && !File.exist?("app/javascript/application.js")
File.write("app/javascript/application.js", <<~JS, mode: "a+")
import "./controllers"
JS
end

block.call
end
end
end
46 changes: 46 additions & 0 deletions test/test_helper.rb
Original file line number Diff line number Diff line change
@@ -1,8 +1,54 @@
require 'rails'
require "rails/test_help"
require "fileutils"

# Configure Rails Environment
ENV["RAILS_ENV"] = "test"

# Set fixture path
ActiveSupport::TestCase.file_fixture_path = File.expand_path("fixtures", __dir__)

module RailsAppHelpers
def self.included(base)
base.include ActiveSupport::Testing::Isolation
end

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 ["']stimulus-rails["'].*/, "")
gemfile << %(gem "stimulus-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 = "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