Windows support (#1919)

* Remove the postinstall scripts and move precompiled tasks to executables in bin

* Adding windows to CI

* cleaning up some paths to differentiate between windows and not

* fixing another path in specs

* do all of the Path need to use .new....

* More work on making windows specs pass

* a few test for windows

* also ignore ameba.exe

* Fixing more specs for Windows

.github/workflows/ci.yml

@@ -12,8 +12,6 @@ jobs:
       fail-fast: false
     runs-on: ubuntu-latest
     continue-on-error: false
-    env:
-      SKIP_LUCKY_TASK_PRECOMPILATION: "1"
     steps:
       - uses: actions/checkout@v4
       - uses: crystal-lang/install-crystal@v1
@@ -29,6 +27,9 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
+        os:
+          - ubuntu-latest
+          - windows-latest
         shard_file:
           - shard.yml
         crystal_version:
@@ -40,19 +41,21 @@ jobs:
           - shard_file: shard.edge.yml
             crystal_version: latest
             experimental: true
+            os: ubuntu-latest
           - shard_file: shard.override.yml
             crystal_version: nightly
             experimental: true
-    runs-on: ubuntu-latest
+            os: ubuntu-latest
+    runs-on: ${{ matrix.os }}
     continue-on-error: ${{ matrix.experimental }}
-    env:
-      SKIP_LUCKY_TASK_PRECOMPILATION: "1"
     steps:
       - uses: actions/checkout@v4
       - uses: crystal-lang/install-crystal@v1
         with:
           crystal: ${{matrix.crystal_version}}
       - name: Install shards
-        run: SHARDS_OVERRIDE=${{ matrix.shard_file }} shards install --ignore-crystal-version
+        run: shards install --skip-postinstall --skip-executables
+        env:
+          SHARDS_OVERRIDE: ${{ matrix.shard_file }}
       - name: Run tests
         run: crystal spec

.gitignore

@@ -1,7 +1,8 @@
 /docs/
 /libs/
 /lib/
-/bin/
+/bin/ameba
+/bin/ameba.*
 /tmp/
 /.shards/
 server

src/precompiled_tasks/exec.cr → bin/lucky.exec.cr

@@ -1,3 +1,3 @@
-require "../../tasks/exec"
+require "lucky/tasks/exec"
 
 Lucky::Exec.new.print_help_or_call(ARGV)

src/precompiled_tasks/gen/action/api.cr → bin/lucky.gen.action.api.cr

@@ -1,3 +1,3 @@
-require "../../../../tasks/gen/action/api"
+require "lucky/tasks/gen/action/api"
 
 Gen::Action::Api.new.print_help_or_call(ARGV)

src/precompiled_tasks/gen/action/browser.cr → bin/lucky.gen.action.browser.cr

@@ -1,3 +1,3 @@
-require "../../../../tasks/gen/action/browser"
+require "lucky/tasks/gen/action/browser"
 
 Gen::Action::Browser.new.print_help_or_call(ARGV)

src/precompiled_tasks/gen/component.cr → bin/lucky.gen.component.cr

@@ -1,3 +1,3 @@
-require "../../../tasks/gen/component"
+require "lucky/tasks/gen/component"
 
 Gen::Component.new.print_help_or_call(ARGV)

src/precompiled_tasks/gen/page.cr → bin/lucky.gen.page.cr

@@ -1,3 +1,3 @@
-require "../../../tasks/gen/page"
+require "lucky/tasks/gen/page"
 
 Gen::Page.new.print_help_or_call(ARGV)

src/precompiled_tasks/gen/secret_key.cr → bin/lucky.gen.secret_key.cr

@@ -1,3 +1,3 @@
-require "../../../tasks/gen/secret_key"
+require "lucky/tasks/gen/secret_key"
 
 Gen::SecretKey.new.print_help_or_call(ARGV)

src/precompiled_tasks/gen/task.cr → bin/lucky.gen.task.cr

@@ -1,3 +1,3 @@
-require "../../../tasks/gen/task"
+require "lucky/tasks/gen/task"
 
 Gen::Task.new.print_help_or_call(ARGV)

src/precompiled_tasks/watch.cr → bin/lucky.watch.cr

@@ -1,3 +1,3 @@
-require "../../tasks/watch"
+require "lucky/tasks/watch"
 
 Watch.new.print_help_or_call(ARGV)

shard.yml

@@ -6,25 +6,16 @@ crystal: ">= 1.10.0"
 authors:
   - Paul Smith <paulcsmith0218@gmail.com>
 
-targets:
-  lucky.exec:
-    main: src/precompiled_tasks/exec.cr
-  lucky.watch:
-    main: src/precompiled_tasks/watch.cr
-  lucky.gen.action:
-    main: src/precompiled_tasks/gen/action/helpful_error.cr
-  lucky.gen.action.browser:
-    main: src/precompiled_tasks/gen/action/browser.cr
-  lucky.gen.action.api:
-    main: src/precompiled_tasks/gen/action/api.cr
-  lucky.gen.page:
-    main: src/precompiled_tasks/gen/page.cr
-  lucky.gen.component:
-    main: src/precompiled_tasks/gen/component.cr
-  lucky.gen.task:
-    main: src/precompiled_tasks/gen/task.cr
-  lucky.gen.secret_key:
-    main: src/precompiled_tasks/gen/secret_key.cr
+executables:
+  - lucky.exec.cr
+  - lucky.watch.cr
+  - lucky.gen.action.cr
+  - lucky.gen.action.browser.cr
+  - lucky.gen.action.api.cr
+  - lucky.gen.page.cr
+  - lucky.gen.component.cr
+  - lucky.gen.task.cr
+  - lucky.gen.secret_key.cr
 
 dependencies:
   lucky_task:
@@ -63,7 +54,4 @@ development_dependencies:
     github: crystal-ameba/ameba
     version: ~> 1.5.0
 
-scripts:
-  postinstall: BUILD_WITHOUT_DEVELOPMENT=true script/precompile_tasks
-
 license: MIT

spec/lucky/component_spec.cr

@@ -114,9 +114,9 @@ describe "components rendering" do
   it "prints a comment when configured to do so" do
     Lucky::HTMLPage.temp_config(render_component_comments: true) do
       contents = TestMountPage.new(context_with_csrf).render.to_s
-      contents.should contain("<!-- BEGIN: ComplexTestComponent spec/lucky/component_spec.cr -->")
+      contents.should contain("<!-- BEGIN: ComplexTestComponent #{component_path} -->")
       contents.should contain("<!-- END: ComplexTestComponent -->")
-      contents.should contain("<!-- BEGIN: ComponentWithBlock spec/lucky/component_spec.cr -->")
+      contents.should contain("<!-- BEGIN: ComponentWithBlock #{component_path} -->")
       contents.should contain("<!-- END: ComponentWithBlock -->")
     end
   end
@@ -142,9 +142,9 @@ describe "components rendering" do
     it "prints a comment when configured to do so" do
       Lucky::HTMLPage.temp_config(render_component_comments: true) do
         contents = TestMountInstancePage.new(build_context).render.to_s
-        contents.should contain("<!-- BEGIN: ComplexInstanceTestComponent spec/lucky/component_spec.cr -->")
+        contents.should contain("<!-- BEGIN: ComplexInstanceTestComponent #{component_path} -->")
         contents.should contain("<!-- END: ComplexInstanceTestComponent -->")
-        contents.should contain("<!-- BEGIN: ComponentWithBlock spec/lucky/component_spec.cr -->")
+        contents.should contain("<!-- BEGIN: ComponentWithBlock #{component_path} -->")
         contents.should contain("<!-- END: ComponentWithBlock -->")
       end
     end
@@ -158,6 +158,10 @@ describe "components rendering" do
   end
 end
 
+private def component_path : String
+  Path.new("spec", "lucky", "component_spec.cr").to_s
+end
+
 private def context_with_csrf : HTTP::Server::Context
   context = build_context
   context.session.set(Lucky::ProtectFromForgery::SESSION_KEY, "my_token")

spec/support/generator_helper.cr

@@ -8,8 +8,8 @@ module GeneratorHelper
 
   private def should_create_files_with_contents(io : IO, **files_and_contents)
     files_and_contents.each do |file_location, file_contents|
-      File.read(file_location.to_s).should contain(file_contents)
-      io.to_s.should contain(file_location.to_s)
+      File.read(Path[file_location.to_s].normalize.to_s).should contain(file_contents)
+      io.to_s.should contain(Path[file_location.to_s].normalize.to_s)
     end
   end
 

spec/tasks/exec_spec.cr

@@ -1,20 +1,24 @@
 require "../spec_helper"
 
 describe Lucky::Exec do
-  it "runs the editor" do
-    with_test_template do
-      Lucky::Exec.new.print_help_or_call(args: ["--once", "--editor", %(echo '5 + 5' >)])
+  {% if flag?(:win32) %}
+    pending "Cry on Windows needs updating"
+  {% else %}
+    it "runs the editor" do
+      with_test_template do
+        Lucky::Exec.new.print_help_or_call(args: ["--once", "--editor", %(echo '5 + 5' >)])
 
-      newest_code.should eq <<-CODE
+        newest_code.should eq <<-CODE
       5 + 5
 
       CODE
+      end
     end
-  end
+  {% end %}
 end
 
 private def with_test_template(&)
-  Lucky::Exec.temp_config(template_path: "spec/support/exec_template.cr.template") do
+  Lucky::Exec.temp_config(template_path: Path["spec/support/exec_template.cr.template"].normalize.to_s) do
     yield
   end
 end

spec/tasks/gen/action_spec.cr

@@ -13,7 +13,7 @@ describe Gen::Action do
       should_have_generated "#{valid_action_name} < BrowserAction", inside: filename
 
       io.to_s.should contain(valid_action_name)
-      io.to_s.should contain("/src/actions/users")
+      io.to_s.should contain(Path["src/actions/users"].normalize.to_s)
     end
   end
 
@@ -29,8 +29,8 @@ describe Gen::Action do
         should_have_generated "#{valid_action_name}Page < MainLayout", inside: page_filename
 
         io.to_s.should contain(valid_action_name)
-        io.to_s.should contain("/src/actions/users")
-        io.to_s.should contain("/src/pages/users")
+        io.to_s.should contain(Path["src/actions/users"].normalize.to_s)
+        io.to_s.should contain(Path["src/pages/users"].normalize.to_s)
       end
     end
 
@@ -43,7 +43,7 @@ describe Gen::Action do
         should_have_generated "#{valid_action_name} < ApiAction", inside: filename
 
         io.to_s.should contain(valid_action_name)
-        io.to_s.should contain("/src/actions/api/users")
+        io.to_s.should contain(Path["src/actions/api/users"].normalize.to_s)
         io.to_s.should contain("No page generated for ApiActions")
       end
     end
@@ -58,7 +58,7 @@ describe Gen::Action do
       should_have_generated "#{valid_action_name} < ApiAction", inside: filename
 
       io.to_s.should contain(valid_action_name)
-      io.to_s.should contain("/src/actions/api/users")
+      io.to_s.should contain(Path["src/actions/api/users"].normalize.to_s)
     end
   end
 
@@ -72,7 +72,7 @@ describe Gen::Action do
       should_have_generated %(get "/users/announcements"), inside: filename
 
       io.to_s.should contain(valid_nested_action_name)
-      io.to_s.should contain("/src/actions/users/announcements")
+      io.to_s.should contain(Path["src/actions/users/announcements"].normalize.to_s)
     end
 
     with_cleanup do
@@ -83,7 +83,7 @@ describe Gen::Action do
       should_have_generated "#{valid_nested_action_name} < ApiAction", inside: filename
 
       io.to_s.should contain(valid_nested_action_name)
-      io.to_s.should contain("/src/actions/api/users/announcements")
+      io.to_s.should contain(Path["src/actions/api/users/announcements"].normalize.to_s)
     end
   end
 

spec/tasks/gen/task_spec.cr

@@ -14,7 +14,7 @@ describe Gen::Task do
   it "generates a task" do
     with_cleanup do
       output = run_with_args ["search.reindex"]
-      output.to_s.should contain("./tasks/search/reindex.cr")
+      output.to_s.should contain(Path["./tasks/search/reindex.cr"].normalize.to_s)
       should_create_files_with_contents output,
         "./tasks/search/reindex.cr": "Search::Reindex"
     end

src/lucky/base_component.cr

@@ -7,7 +7,7 @@ abstract class Lucky::BaseComponent
     # Returns the relative file location to the
     # project root. e.g. src/components/my_component.cr
     def self.file_location
-      __FILE__.gsub("#{Dir.current}/", "")
+      __FILE__.gsub(Dir.current, "").byte_slice(1)
     end
   end
 

src/lucky/static_compression_handler.cr

@@ -21,8 +21,7 @@ class Lucky::StaticCompressionHandler
   def call(context)
     original_path = context.request.path.to_s
     request_path = URI.decode(original_path)
-    expanded_path = File.expand_path(request_path, "/")
-    file_path = File.join(@public_dir, expanded_path)
+    file_path = File.join(@public_dir, request_path)
     compressed_path = "#{file_path}.#{@file_ext}"
     content_type = MIME.from_filename(file_path, "application/octet-stream")
 

tasks/exec.cr

@@ -14,7 +14,7 @@ class Lucky::Exec < LuckyTask::Task
 
   Habitat.create do
     setting editor : String = "vim"
-    setting template_path : String = "#{__DIR__}/exec_template.cr.template"
+    setting template_path : String = Path["#{__DIR__}/exec_template.cr.template"].normalize.to_s
   end
 
   def help_message

tasks/gen/action/action_generator.cr

@@ -72,7 +72,7 @@ module Gen::ActionGenerator
   end
 
   private def output_path
-    Path["./src/actions/#{path}"]
+    Path["./src/actions/#{path}"].normalize
   end
 
   private def path

tasks/gen/component.cr

@@ -72,7 +72,7 @@ class Gen::Component < LuckyTask::Task
   private def output_path
     parts = component_class.split("::")
     parts.pop
-    Path["./src/components/#{parts.map(&.underscore.downcase).join('/')}"]
+    Path["./src/components/#{parts.map(&.underscore.downcase).join('/')}"].normalize
   end
 
   private def output_path_with_filename

tasks/gen/page.cr

@@ -68,7 +68,7 @@ class Gen::Page < LuckyTask::Task
   private def output_path
     page_parts = page_class.split("::")
     page_parts.pop
-    Path["./src/pages/#{page_parts.map(&.underscore.downcase).join('/')}"]
+    Path["./src/pages/#{page_parts.map(&.underscore.downcase).join('/')}"].normalize
   end
 
   private def output_path_with_filename