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

Add option to run non-compiled crystal scripts from bin #871

Merged
merged 1 commit into from
Oct 12, 2024
Merged
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
1 change: 1 addition & 0 deletions Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ integration-specs:
FROM +base-image
COPY +build-lucky/lucky /usr/bin/lucky
COPY fixtures/hello_world.cr fixtures/
COPY fixtures/hello_crystal.cr bin/lucky.hello_crystal.cr
COPY fixtures/tasks.cr fixtures/
RUN shards build lucky.hello_world --without-development
RUN crystal spec --tag integration
Expand Down
1 change: 1 addition & 0 deletions fixtures/hello_crystal.cr
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
puts "Hello, Crystal!"
29 changes: 20 additions & 9 deletions spec/integration/lucky_cli_spec.cr
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,21 @@ describe "Lucky CLI", tags: "integration" do
shell: true,
output: io
)
status.exit_status.should eq(0)
status.exit_code.should eq(0)
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These changes are related to crystal-lang/crystal#8381

io.to_s.should eq("Hello World!\n")
end

it "runs non-compiled tasks" do
io = IO::Memory.new
status = run_lucky(
args: %w[hello_crystal],
shell: true,
output: io
)
status.exit_code.should eq(0)
io.to_s.should eq("Hello, Crystal!\n")
end

it "allows tasks to accept input from STDIN" do
io = IO::Memory.new
run_lucky(
Expand All @@ -32,7 +43,7 @@ describe "Lucky CLI", tags: "integration" do
it "returns the lucky CLI help message when passing the -h flag" do
io = IO::Memory.new
status = run_lucky(args: %w[-h], shell: true, output: io)
status.exit_status.should eq(0)
status.exit_code.should eq(0)
io.to_s.should contain("Usage: lucky [command]")
end

Expand All @@ -47,7 +58,7 @@ describe "Lucky CLI", tags: "integration" do
"LUCKY_TASKS_FILE" => fixtures_tasks_path.to_s,
}
)
status.exit_status.should eq(0)
status.exit_code.should eq(0)
io.to_s.should contain("Usage: lucky tasks")
end

Expand All @@ -61,7 +72,7 @@ describe "Lucky CLI", tags: "integration" do
"LUCKY_TASKS_FILE" => fixtures_tasks_path.to_s,
}
)
status.exit_status.should eq(0)
status.exit_code.should eq(0)
io.to_s.should contain("Usage: lucky dev")
end
end
Expand All @@ -78,7 +89,7 @@ describe "Lucky CLI", tags: "integration" do
"LUCKY_TASKS_FILE" => fixtures_tasks_path.to_s,
}
)
status.exit_status.should eq(0)
status.exit_code.should eq(0)
io.to_s.should contain("Custom help message")
end
end
Expand All @@ -99,7 +110,7 @@ describe "Lucky CLI", tags: "integration" do
args: %w[init.custom test-project --dir my-project],
shell: true,
)
status.exit_status.should eq(0)
status.exit_code.should eq(0)
Dir.cd("my-project/test-project") do
File.read("src/shards.cr").should contain("lucky")
end
Expand All @@ -113,7 +124,7 @@ describe "Lucky CLI", tags: "integration" do
shell: true,
output: io
)
status.exit_status.should eq(0)
status.exit_code.should eq(0)
io.to_s.should contain("Folder named test-project already exists, please use a different name")
end

Expand All @@ -124,7 +135,7 @@ describe "Lucky CLI", tags: "integration" do
shell: true,
output: io
)
status.exit_status.should_not eq(0)
status.exit_code.should_not eq(0)
io.to_s.should contain("Project name should only contain lowercase letters, numbers, underscores, and dashes.")
end

Expand All @@ -135,7 +146,7 @@ describe "Lucky CLI", tags: "integration" do
shell: true,
output: io
)
status.exit_status.should_not eq(0)
status.exit_code.should_not eq(0)
io.to_s.should contain("Projects cannot be named app, app_database, app_server, shards, start_server.")
end
end
Expand Down
31 changes: 23 additions & 8 deletions src/lucky.cr
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,29 @@ require "./build_and_run_task"
include LuckyTask::TextHelpers

args = ARGV.join(" ")
tasks_file = ENV.fetch("LUCKY_TASKS_FILE", "./tasks.cr")
tasks_file = ENV.fetch("LUCKY_TASKS_FILE", Path["./tasks.cr"].to_s)
inside_app_directory = File.file?(tasks_file)

private def task_name : String?
ARGV.first?
end

private def task_precompiled? : Bool
path = precompiled_task_path
!path.nil? && File.file?(path)
private def task_compiled? : Bool
path = task_path
!path.nil? && {% if compare_versions(Crystal::VERSION, "1.13.0") >= 0 %}File::Info.executable?(path){% else %}File.executable?(path){% end %}
end

private def precompiled_task_path : String?
private def task_path(ext : String = "") : Path?
task_name.try do |name|
"bin/lucky.#{name}"
Path.new("bin", "lucky.#{name}#{ext}")
end
end

private def task_not_compiled? : Bool
path = task_path(".cr")
!path.nil? && File.file?(path)
end

private def built_in_commands : Array(String)
["dev", "tasks", "init", "init.custom"]
end
Expand Down Expand Up @@ -148,15 +153,25 @@ elsif start_wizard
LuckyCli::Init.run
elsif generate_custom_app
# already running
elsif task_precompiled?
elsif task_compiled?
exit Process.run(
precompiled_task_path.to_s,
task_path.to_s,
ARGV.skip(1),
shell: true,
input: STDIN,
output: STDOUT,
error: STDERR
).exit_code
elsif task_not_compiled?
crystal_command = {% if flag?(:windows) %}"crystal.exe"{% else %}"crystal"{% end %}
exit Process.run(
crystal_command,
[task_path(".cr").to_s] + ARGV.skip(1),
shell: true,
input: STDIN,
output: STDOUT,
error: STDERR
).exit_code
elsif inside_app_directory
# Run task from tasks.cr file since this task is not precompiled
LuckyCli::BuildAndRunTask.call(tasks_file, args)
Expand Down
Loading