Merge pull request #298 from elixirkoans/iamvery/maintenance

Tweaks and adjustments to modernize this repo

Author: iamvery

.github/workflows/elixir.yml

@@ -9,30 +9,44 @@ on:
 
 jobs:
   build:
+    runs-on: ubuntu-latest
 
-    name: Build and test
-    runs-on: ubuntu-20.04
+    env:
+      MIX_ENV: test
+
+    strategy:
+      matrix:
+        elixir: [1.18.4]
+        otp: [28.0.2]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: System dependencies
-      run: |
-        sudo apt update
-        sudo apt install -y inotify-tools
-    - name: Set up Elixir
-      uses: erlef/setup-beam@988e02bfe678367a02564f65ca2e37726dc0268f
-      with:
-        elixir-version: '1.12.3' # Define the elixir version [required]
-        otp-version: '24.1' # Define the OTP version [required]
-    - name: Restore dependencies cache
-      uses: actions/cache@v2
-      with:
-        path: deps
-        key: ${{ runner.os }}-mix-${{ hashFiles('**/mix.lock') }}
-        restore-keys: ${{ runner.os }}-mix-
-    - name: Install dependencies
-      run: mix deps.get
-    - name: Run tests
-      run: mix test
-    - name: Run static analytics
-      run: mix credo suggest --all --strict
+      - uses: actions/checkout@v4
+      - name: System Dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y inotify-tools
+      - name: Setup Elixir
+        uses: erlef/setup-beam@v1
+        with:
+          otp-version: ${{ matrix.otp }}
+          elixir-version: ${{ matrix.elixir }}
+      - name: Restore dependencies cache
+        uses: actions/cache@v4
+        with:
+          path: |
+            deps
+            _build
+          key: mix-${{ runner.os }}-${{matrix.elixir}}-${{matrix.otp}}-${{ hashFiles('**/mix.lock') }}
+          restore-keys: |
+            mix-${{ runner.os }}-${{matrix.elixir}}-${{matrix.otp}}-
+
+      - name: Install dependencies
+        run: mix deps.get
+      - name: Check code format
+        run: mix format --check-formatted
+      - name: Run static analysis
+        run: mix credo --strict
+      - name: Check for unneeded dependencies
+        run: mix deps.unlock --check-unused
+      - name: Run tests
+        run: mix test

CNAME

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2015  http://elixirkoans.io
+Copyright (c) 2015 Elixir Koans
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

LICENSE.md

@@ -22,7 +22,7 @@ defmodule Display do
   end
 
   def handle_call(:clear_screen, _from, %{clear_screen: true} = state) do
-    ANSI.clear <> ANSI.home |> IO.puts()
+    (ANSI.clear() <> ANSI.home()) |> IO.puts()
 
     {:reply, :ok, state}
   end
@@ -58,6 +58,7 @@ defmodule Display do
   defp format(failure, module, name) do
     progress_bar = ProgressBar.progress_bar(Tracker.summarize())
     progress_bar_underline = String.duplicate("-", String.length(progress_bar))
+
     """
     #{Intro.intro(module, Tracker.visited())}
     Now meditate upon #{format_module(module)}

lib/display.ex

@@ -50,7 +50,7 @@ defmodule Display.Failure do
   end
 
   defp format_error(error) do
-    trace = System.stacktrace() |> Enum.take(2)
+    trace = Process.info(self(), :current_stacktrace) |> Enum.take(2)
     Paint.red(Exception.format(:error, error, trace))
   end
 

lib/display/failure.ex

@@ -6,7 +6,7 @@ defmodule Display.Intro do
     if module in modules do
       ""
     else
-      show_intro(module.intro)
+      module.intro() |> show_intro()
     end
   end
 

lib/display/intro.ex

@@ -6,7 +6,9 @@ defmodule Display.ProgressBar do
     arrow = calculate_progress(current, total) |> build_arrow
     progress_percentage = calculate_percentage(current, total)
 
-    "|" <> String.pad_trailing(arrow, @progress_bar_length) <> "| #{current} of #{total} -> #{progress_percentage}% complete"
+    "|" <>
+      String.pad_trailing(arrow, @progress_bar_length) <>
+      "| #{current} of #{total} -> #{progress_percentage}% complete"
   end
 
   defp calculate_progress(current, total) do

lib/display/progress_bar.ex

@@ -3,13 +3,11 @@ defmodule ElixirKoans do
   use Application
 
   def start(_type, _args) do
-    import Supervisor.Spec
-
     children = [
-      worker(Display, []),
-      worker(Tracker, []),
-      worker(Runner, []),
-      worker(Watcher, [])
+      %{id: Display, start: {Display, :start_link, []}},
+      %{id: Tracker, start: {Tracker, :start_link, []}},
+      %{id: Runner, start: {Runner, :start_link, []}},
+      %{id: Watcher, start: {Watcher, :start_link, []}}
     ]
 
     opts = [strategy: :one_for_one, name: ElixirKoans.Supervisor]

lib/elixir_koans.ex

@@ -1,7 +1,8 @@
 defmodule Execute do
   @moduledoc false
   def run_module(module, callback \\ fn _result, _module, _koan -> nil end) do
-    Enum.reduce_while(module.all_koans, :passed, fn koan, _ ->
+    module.all_koans()
+    |> Enum.reduce_while(:passed, fn koan, _ ->
       module
       |> run_koan(koan)
       |> hook(module, koan, callback)

lib/execute.ex

@@ -110,7 +110,7 @@ defmodule Numbers do
   end
 
   koan "I want the first and last in the range" do
-    first..last = Range.new(1, 10)
+    first..last//_step = Range.new(1, 10)
 
     assert first == ___
     assert last == ___
@@ -124,11 +124,11 @@ defmodule Numbers do
     assert 0 in range == ___
   end
 
-  def is_range?(%Range{}), do: true
-  def is_range?(_), do: false
+  def range?(%Range{}), do: true
+  def range?(_), do: false
 
   koan "Is this a range?" do
-    assert is_range?(1..10) == ___
-    assert is_range?(0) == ___
+    assert range?(1..10) == ___
+    assert range?(0) == ___
   end
 end