Windows Support

.gitattributes

@@ -0,0 +1 @@
+*.cr text eol=lf

.github/workflows/ci.yml

@@ -45,7 +45,7 @@ jobs:
         os:
           - ubuntu-latest
           - macos-latest
-          # - windows-latest
+          - windows-latest
         crystal:
           - latest
           - nightly
@@ -67,3 +67,4 @@ jobs:
           SHARDS_OVERRIDE: shard.dev.yml
       - name: Specs
         run: ./scripts/test.sh
+        shell: bash

src/components/console/spec/application_spec.cr

@@ -19,7 +19,7 @@ struct ApplicationTest < ASPEC::TestCase
 
   protected def assert_file_equals_string(filepath : String, string : String, *, file : String = __FILE__, line : Int32 = __LINE__) : Nil
     normalized_path = File.join __DIR__, "fixtures", filepath
-    string.should match(Regex.new(File.read(normalized_path))), file: file, line: line
+    string.should match(Regex.new(File.read(normalized_path).gsub ACON::System::EOL, "\n")), file: file, line: line
   end
 
   protected def ensure_static_command_help(application : ACON::Application) : Nil
@@ -340,7 +340,7 @@ struct ApplicationTest < ASPEC::TestCase
 
     tester = ACON::Spec::ApplicationTester.new app
     tester.run command: "foos:bar1", decorated: false
-    self.assert_file_equals_string "text/application_alternative_namespace.txt", tester.display
+    self.assert_file_equals_string "text/application_alternative_namespace.txt", tester.display true
   end
 
   def test_run_alternate_command_name : Nil
@@ -525,10 +525,10 @@ struct ApplicationTest < ASPEC::TestCase
 
     app.catch_exceptions = true
     tester.run command: "foo", decorated: false
-    self.assert_file_equals_string "text/application_renderexception1.txt", tester.display
+    self.assert_file_equals_string "text/application_renderexception1.txt", tester.display true
 
     tester.run command: "foo", decorated: false, capture_stderr_separately: true
-    self.assert_file_equals_string "text/application_renderexception1.txt", tester.error_output
+    self.assert_file_equals_string "text/application_renderexception1.txt", tester.error_output true
     tester.display.should be_empty
 
     app.catch_exceptions = false
@@ -545,38 +545,38 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "foo", decorated: false, capture_stderr_separately: true
-    self.assert_file_equals_string "text/application_renderexception1.txt", tester.error_output
+    self.assert_file_equals_string "text/application_renderexception1.txt", tester.error_output true
 
     tester.run command: "foo", decorated: false, capture_stderr_separately: true, verbosity: :verbose
     tester.error_output.should contain "Exception trace"
 
     tester.run command: "list", "--foo": true, decorated: false, capture_stderr_separately: true
-    self.assert_file_equals_string "text/application_renderexception2.txt", tester.error_output
+    self.assert_file_equals_string "text/application_renderexception2.txt", tester.error_output true
 
     app.add Foo3Command.new
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "foo3:bar", decorated: false, capture_stderr_separately: true
-    self.assert_file_equals_string "text/application_renderexception3.txt", tester.error_output
+    self.assert_file_equals_string "text/application_renderexception3.txt", tester.error_output true
 
     tester.run({"command" => "foo3:bar"}, decorated: false, verbosity: :verbose)
-    tester.display.should match /\[Exception\]\s*First exception/
-    tester.display.should match /\[Exception\]\s*Second exception/
-    tester.display.should match /\[Exception\]\s*Third exception/
+    tester.display(true).should match /\[Exception\]\s*First exception/
+    tester.display(true).should match /\[Exception\]\s*Second exception/
+    tester.display(true).should match /\[Exception\]\s*Third exception/
 
     tester.run command: "foo3:bar", decorated: true
-    self.assert_file_equals_string "text/application_renderexception3_decorated.txt", tester.display
+    self.assert_file_equals_string "text/application_renderexception3_decorated.txt", tester.display true
 
     tester.run command: "foo3:bar", decorated: true, capture_stderr_separately: true
-    self.assert_file_equals_string "text/application_renderexception3_decorated.txt", tester.error_output
+    self.assert_file_equals_string "text/application_renderexception3_decorated.txt", tester.error_output true
 
     app = ACON::Application.new "foo"
     app.auto_exit = false
     ENV["COLUMNS"] = "32"
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "foo", decorated: false, capture_stderr_separately: true
-    self.assert_file_equals_string "text/application_renderexception4.txt", tester.error_output
+    self.assert_file_equals_string "text/application_renderexception4.txt", tester.error_output true
 
     ENV["COLUMNS"] = "120"
   end
@@ -605,7 +605,7 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "foo", decorated: false
-    self.assert_file_equals_string "text/application_renderexception_escapeslines.txt", tester.display
+    self.assert_file_equals_string "text/application_renderexception_escapeslines.txt", tester.display true
 
     ENV["COLUMNS"] = "120"
   end
@@ -620,7 +620,7 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "foo", decorated: false
-    self.assert_file_equals_string "text/application_renderexception_linebreaks.txt", tester.display
+    self.assert_file_equals_string "text/application_renderexception_linebreaks.txt", tester.display true
   end
 
   def test_render_exception_escapes_lines_of_synopsis : Nil
@@ -633,7 +633,7 @@ struct ApplicationTest < ASPEC::TestCase
 
     tester = ACON::Spec::ApplicationTester.new app
     tester.run command: "foo", decorated: false
-    self.assert_file_equals_string "text/application_renderexception_synopsis_escapeslines.txt", tester.display
+    self.assert_file_equals_string "text/application_renderexception_synopsis_escapeslines.txt", tester.display true
   end
 
   def test_run_passes_io_thru : Nil
@@ -660,7 +660,7 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run decorated: false
-    self.assert_file_equals_string "text/application_run1.txt", tester.display
+    self.assert_file_equals_string "text/application_run1.txt", tester.display true
   end
 
   def test_run_help_command : Nil
@@ -672,10 +672,10 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run "--help": true, decorated: false
-    self.assert_file_equals_string "text/application_run2.txt", tester.display
+    self.assert_file_equals_string "text/application_run2.txt", tester.display true
 
     tester.run "-h": true, decorated: false
-    self.assert_file_equals_string "text/application_run2.txt", tester.display
+    self.assert_file_equals_string "text/application_run2.txt", tester.display true
   end
 
   def test_run_help_list_command : Nil
@@ -687,10 +687,10 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "list", "--help": true, decorated: false
-    self.assert_file_equals_string "text/application_run3.txt", tester.display
+    self.assert_file_equals_string "text/application_run3.txt", tester.display true
 
     tester.run command: "list", "-h": true, decorated: false
-    self.assert_file_equals_string "text/application_run3.txt", tester.display
+    self.assert_file_equals_string "text/application_run3.txt", tester.display true
   end
 
   def test_run_ansi : Nil
@@ -713,10 +713,10 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run "--version": true, decorated: false
-    self.assert_file_equals_string "text/application_run4.txt", tester.display
+    self.assert_file_equals_string "text/application_run4.txt", tester.display true
 
     tester.run "-V": true, decorated: false
-    self.assert_file_equals_string "text/application_run4.txt", tester.display
+    self.assert_file_equals_string "text/application_run4.txt", tester.display true
   end
 
   def test_run_quest : Nil
@@ -776,10 +776,10 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "help", "--help": true, decorated: false
-    self.assert_file_equals_string "text/application_run5.txt", tester.display
+    self.assert_file_equals_string "text/application_run5.txt", tester.display true
 
     tester.run command: "help", "-h": true, decorated: false
-    self.assert_file_equals_string "text/application_run5.txt", tester.display
+    self.assert_file_equals_string "text/application_run5.txt", tester.display true
   end
 
   def test_run_no_interaction : Nil
@@ -792,10 +792,10 @@ struct ApplicationTest < ASPEC::TestCase
     tester = ACON::Spec::ApplicationTester.new app
 
     tester.run command: "foo:bar", "--no-interaction": true, decorated: false
-    tester.display.should eq "execute called\n"
+    tester.display.should eq "execute called#{ACON::System::EOL}"
 
     tester.run command: "foo:bar", "-n": true, decorated: false
-    tester.display.should eq "execute called\n"
+    tester.display.should eq "execute called#{ACON::System::EOL}"
   end
 
   def test_run_global_option_and_no_command : Nil
@@ -974,7 +974,7 @@ struct ApplicationTest < ASPEC::TestCase
 
     tester = ACON::Spec::ApplicationTester.new app
     tester.run interactive: false
-    tester.display.should eq "execute called\n"
+    tester.display.should eq "execute called#{ACON::System::EOL}"
 
     # TODO: Test custom application default.
   end
@@ -987,7 +987,7 @@ struct ApplicationTest < ASPEC::TestCase
 
     tester = ACON::Spec::ApplicationTester.new app
     tester.run "--fooopt": "opt", interactive: false
-    tester.display.should eq "execute called\nopt\n"
+    tester.display.should eq "execute called#{ACON::System::EOL}opt#{ACON::System::EOL}"
   end
 
   def test_run_custom_single_default_command : Nil

src/components/console/spec/application_tester_spec.cr

@@ -29,11 +29,11 @@ struct ApplicationTesterTest < ASPEC::TestCase
   end
 
   def test_output : Nil
-    @tester.output.to_s.should eq "foo\n"
+    @tester.output.to_s.should eq "foo#{ACON::System::EOL}"
   end
 
   def test_display : Nil
-    @tester.display.to_s.should eq "foo\n"
+    @tester.display.to_s.should eq "foo#{ACON::System::EOL}"
   end
 
   def test_status : Nil

src/components/console/spec/command_spec.cr

@@ -179,13 +179,13 @@ describe ACON::Command do
     it "interactive" do
       tester = ACON::Spec::CommandTester.new TestCommand.new
       tester.execute interactive: true
-      tester.display.should eq "interact called\nexecute called\n"
+      tester.display.should eq "interact called#{ACON::System::EOL}execute called#{ACON::System::EOL}"
     end
 
     it "non-interactive" do
       tester = ACON::Spec::CommandTester.new TestCommand.new
       tester.execute interactive: false
-      tester.display.should eq "execute called\n"
+      tester.display.should eq "execute called#{ACON::System::EOL}"
     end
 
     it "invalid option" do

src/components/console/spec/command_tester_spec.cr

@@ -28,11 +28,11 @@ struct CommandTesterTest < ASPEC::TestCase
   end
 
   def test_output : Nil
-    @tester.output.to_s.should eq "foo\n"
+    @tester.output.to_s.should eq "foo#{ACON::System::EOL}"
   end
 
   def test_display : Nil
-    @tester.display.to_s.should eq "foo\n"
+    @tester.display.to_s.should eq "foo#{ACON::System::EOL}"
   end
 
   def test_display_before_calling_execute : Nil

src/components/console/spec/commands/list_spec.cr

@@ -1,5 +1,9 @@
 require "../spec_helper"
 
+private def normalize(input : String) : String
+  input.gsub ACON::System::EOL, "\n"
+end
+
 struct ListCommandTest < ASPEC::TestCase
   def test_execute_lists_commands : Nil
     app = ACON::Application.new "foo"
@@ -34,7 +38,7 @@ struct ListCommandTest < ASPEC::TestCase
     tester = ACON::Spec::CommandTester.new app.get("list")
     tester.execute command: "list", decorated: false
 
-    tester.display.should eq <<-OUTPUT
+    tester.display(true).should eq normalize <<-OUTPUT
       foo 0.1.0
 
       Usage:

src/components/console/spec/cursor_spec.cr

@@ -100,8 +100,9 @@ struct CursorTest < ASPEC::TestCase
     position.should eq({1, 1})
   end
 
-  # TODO: Figure out a less brittle way of testing this.
-  def ptest_current_position_tty : Nil
+  def test_current_position_tty : Nil
+    pending! "Cursor input must be a TTY" unless STDIN.tty?
+
     @cursor = ACON::Cursor.new @output
 
     @cursor.move_to_position 10, 10

src/components/console/spec/descriptor/abstract_descriptor_test_case.cr

@@ -62,6 +62,10 @@ abstract struct AbstractDescriptorTestCase < ASPEC::TestCase
     context = context.clone
     context.raw_output = true
     self.descriptor.describe output, object, context
-    output.to_s.strip.should eq expected.strip
+    self.normalize_output(output.to_s).should eq self.normalize_output(expected)
+  end
+
+  private def normalize_output(output : String) : String
+    output.gsub(ACON::System::EOL, "\n").strip
   end
 end

src/components/console/spec/helper/abstract_question_helper_test_case.cr

@@ -16,10 +16,16 @@ abstract struct AbstractQuestionHelperTest < ASPEC::TestCase
     yield input
   end
 
-  protected def assert_output_contains(string : String) : Nil
+  protected def assert_output_contains(string : String, normalize : Bool = false) : Nil
     stream = @output.io
     stream.rewind
 
-    stream.to_s.should contain string
+    output = stream.to_s
+
+    if normalize
+      output = output.gsub ACON::System::EOL, "\n"
+    end
+
+    output.should contain string
   end
 end

src/components/console/spec/helper/athena_question_spec.cr

@@ -135,7 +135,7 @@ struct AthenaQuestionTest < AbstractQuestionHelperTest
       @helper.ask input, @output, question
     end
 
-    self.assert_output_contains <<-OUT
+    self.assert_output_contains <<-OUT, true
      qqq:
       [foo   ] foo
       [żółw  ] bar
@@ -152,7 +152,7 @@ struct AthenaQuestionTest < AbstractQuestionHelperTest
       @helper.ask input, @output, question
     end
 
-    self.assert_output_contains <<-OUT
+    self.assert_output_contains <<-OUT, true
      qqq:
       [0] foo
      >ccc>

src/components/console/spec/helper/formatter_spec.cr

@@ -1,5 +1,9 @@
 require "../spec_helper"
 
+private def normalize(input : String) : String
+  input.gsub ACON::System::EOL, "\n"
+end
+
 describe ACON::Helper::Formatter do
   it "#format_section" do
     ACON::Helper::Formatter.new.format_section("cli", "some text to display").should eq "<info>[cli]</info> some text to display"
@@ -11,7 +15,7 @@ describe ACON::Helper::Formatter do
 
       formatter.format_block("Some text to display", "error").should eq "<error> Some text to display </error>"
       formatter.format_block({"Some text to display", "foo bar"}, "error").should eq "<error> Some text to display </error>\n<error> foo bar              </error>"
-      formatter.format_block("Some text to display", "error", true).should eq <<-BLOCK
+      formatter.format_block("Some text to display", "error", true).should eq normalize <<-BLOCK
       <error>                        </error>
       <error>  Some text to display  </error>
       <error>                        </error>
@@ -21,7 +25,7 @@ describe ACON::Helper::Formatter do
     it "formats with diacritic letters" do
       formatter = ACON::Helper::Formatter.new
 
-      formatter.format_block("Du texte à afficher", "error", true).should eq <<-BLOCK
+      formatter.format_block("Du texte à afficher", "error", true).should eq normalize <<-BLOCK
       <error>                       </error>
       <error>  Du texte à afficher  </error>
       <error>                       </error>
@@ -32,7 +36,7 @@ describe ACON::Helper::Formatter do
     end
 
     it "escapes < within the block" do
-      ACON::Helper::Formatter.new.format_block("<info>some info</info>", "error", true).should eq <<-BLOCK
+      ACON::Helper::Formatter.new.format_block("<info>some info</info>", "error", true).should eq normalize <<-BLOCK
       <error>                            </error>
       <error>  \\<info>some info\\</info>  </error>
       <error>                            </error>