Introduce Elixir

We now assume that Elixir is installed as a dependency for development.

This now gives us access to mix for building, creating releases and developing the Erlang code base. The Erlang OTP app has now been converted to an Elixir OTP app (which currently just starts the Erlang processes after setting some environment values).

However, the door is now open for future Elixir extensions and access to dependency management via mix. We also have a nice path for including Rust NIFs through the Rustler lib.

We also remove the old prebuild binaries for macOS and Windows as these can now be generated via `mix release`.

Author: samaaron

.github/workflows/build.yml

@@ -79,26 +79,32 @@ jobs:
         extra: '--b http://mirrors.ocf.berkeley.edu/qt/'
         cached: ${{ steps.cache-qt2.outputs.cache-hit }}
 
-      # Latest Erlang on Ubuntu
-    - uses: gleam-lang/setup-erlang@v1.1.2
+      # Install Elixir on Ubuntu
+    - uses: erlef/setup-beam@v1
       with:
-        otp-version: 23.2.1
+        otp-version: 24
       if: matrix.os == 'ubuntu-latest'
 
-      # Install Erlang on MacOS
-    - name: Mac Erlang
+      # Install Elixir on Windows
+    - uses: erlef/setup-beam@v1
+      with:
+        otp-version: '24'
+      if: matrix.os == 'windows-latest'
+
+      # Install Elixir on MacOS
+    - name: Mac Elixir
       continue-on-error: true
       run: |
         export HOMEBREW_NO_INSTALL_CLEANUP=1
         brew update
-        brew install erlang
+        brew install elixir
       if: matrix.os == 'macos-latest'
 
       # Prebuild on Ubuntu
     - name: Prebuild Linux
       working-directory: ${{github.workspace}}/app
       env:
-        CC: ${{ matrix.cc }}  
+        CC: ${{ matrix.cc }}
         QT_INSTALL_LOCATION: ${{env.Qt5_DIR}}
       run: |
         sudo apt install -y pulseaudio dbus-x11 libssl-dev ruby-dev supercollider-server sc3-plugins-server alsa-utils jackd2 libjack-jackd2-dev libjack-jackd2-0 libasound2-dev librtmidi-dev pulseaudio-module-jack
@@ -109,34 +115,34 @@ jobs:
     - name: Prebuild Mac
       working-directory: ${{github.workspace}}/app
       env:
-        CC: ${{ matrix.cc }}  
+        CC: ${{ matrix.cc }}
         QT_INSTALL_LOCATION: ${{env.Qt5_DIR}}
       run: |
         ./mac-prebuild.sh
       if: matrix.os == 'macos-latest'
-   
+
     # Prebuild on Windows
-    # Note that we 'hide' the msys folders on windows to stop conflicts when building 
+    # Note that we 'hide' the msys folders on windows to stop conflicts when building
     # Flac
     - name: Prebuild Windows
       working-directory: ${{github.workspace}}/app
       shell: cmd
       env:
-        CC: ${{ matrix.cc }}  
+        CC: ${{ matrix.cc }}
         QT_INSTALL_LOCATION: ${{env.Qt5_DIR}}
       run: |
         mv c:/msys64 c:/__msys64
         win-prebuild.bat
       if: matrix.os == 'windows-latest'
-    
+
       #- name: Setup tmate session
       # uses: mxschmitt/action-tmate@v3
 
       # Run Configuration Config on Ubuntu
     - name: Config Linux
       working-directory: ${{github.workspace}}/app
       env:
-        CC: ${{ matrix.cc }}  
+        CC: ${{ matrix.cc }}
         QT_INSTALL_LOCATION: ${{env.Qt5_DIR}}
       run: |
         ./linux-config.sh
@@ -146,7 +152,7 @@ jobs:
     - name: Config Mac
       working-directory: ${{github.workspace}}/app
       env:
-        CC: ${{ matrix.cc }}  
+        CC: ${{ matrix.cc }}
         QT_INSTALL_LOCATION: ${{env.Qt5_DIR}}
       run: |
         ./mac-config.sh
@@ -157,35 +163,35 @@ jobs:
       working-directory: ${{github.workspace}}/app
       shell: cmd
       env:
-        CC: ${{ matrix.cc }}  
+        CC: ${{ matrix.cc }}
         QT_INSTALL_LOCATION: ${{env.Qt5_DIR}}
       run: |
         win-config.bat
       if: matrix.os == 'windows-latest'
-    
+
     # Finally: Build
     - name: Do build
       working-directory: ${{github.workspace}}/app/build
       run: cmake --build . --config ${{ matrix.build_type }}
-    
+
     - name: Ruby Tests (Mac/Linux)
       working-directory: ${{github.workspace}}/app/server/ruby
-      run: rake test 
+      run: rake test
       if: matrix.os == 'ubuntu-latest' || matrix.os == 'macos-latest'
 
     - name: API Tests - Mac
       working-directory: ${{github.workspace}}/app/build/api-tests
       run: ctest --verbose
       if: matrix.os == 'macos-latest'
-    
+
     - name: API Tests - Linux
       working-directory: ${{github.workspace}}/app/build/api-tests
       run: |
         jackd -d dummy &
         ctest --verbose
-      if: matrix.os == 'ubuntu-latest' 
-    
-    - name: API Tests Windows - Install Scream Audio Device 
+      if: matrix.os == 'ubuntu-latest'
+
+    - name: API Tests Windows - Install Scream Audio Device
       shell: powershell
       run: |
         Start-Service audio*
@@ -212,5 +218,3 @@ jobs:
           name: Logs_${{matrix.title}}_${{matrix.build_type}}
           path: |
             ~/.sonic-pi/log/*.log
-
-

BUILD-LINUX.md

@@ -43,22 +43,23 @@ few dependencies:
 * Qt + Dev tools (5.15+)
 * Jack (and pulse-audio-module-jack if you are running Raspberry Pi OS)
 * Ruby + Dev tools (2.5+)
-* Erlang + Dev tools (21+)
+* Elixir + Dev tools (21+)
 * SuperCollider + SC3 plugins
 * 
 
 
 ### 1.1 Raspberry Pi OS
 
-The following is a list of packages required for Raspberry Pi OS released in Dec 2020:
+The following is a list of packages required for Raspberry Pi OS
+released in August 2021:
 
 ```  
 sudo apt-get install -y \
-     build-essential cmake git libssl-dev \
-     ruby-dev erlang-base erlang-dev erlang-tools \
-     supercollider-server sc3-plugins-server alsa-utils libaubio5  jackd2 libjack-jackd2-dev libjack-jackd2-0 libasound2-dev librtmidi-dev pulseaudio-module-jack\
-     qt5-default qttools5-dev-tools libqt5concurrent5 libqt5core5a libqt5gui5 libqt5network5 libqt5opengl5 libqt5printsupport5 libqt5concurrent5 libqt5svg5 libqt5widgets5 libqt5svg5-dev \
-     compton pulseaudio-module-jack
+     build-essential git libssl-dev \
+     ruby-dev erlang-base erlang-dev erlang-tools elixir \
+     qttools5-dev-tools qttools5-dev libqt5svg5-dev  \
+     supercollider-server sc3-plugins-server alsa-utils libaubio5  librtmidi-dev libasound2-dev  \
+     jackd2 libjack-jackd2-dev libjack-jackd2-0  pulseaudio-module-jack \
 ```     
 
 

BUILD-MAC.md

@@ -39,7 +39,7 @@ few dependencies:
 
 1. Xcode (12.1+) and command line tools
 2. Homebrew
-3. All other dependencies - Qt5 (5.15+), CMake (3.18+)
+3. All other dependencies - Qt5 (5.15+), CMake (3.18+), Elixir(2.12+)
 
 ### 1.1 Install Xcode
 
@@ -68,7 +68,7 @@ Once you have Homebrew installed, pulling in the rest of the
 dependencies is a couple of lines to execute within a terminal:
 
 ```
-brew install qt@5 cmake
+brew install qt@5 cmake elixir
 
 ```
 

BUILD-WINDOWS.md

@@ -46,6 +46,7 @@ dependencies:
 2. Qt (5.15+)
 3. CMake (3.18+)
 4. Ruby (2.7.1+)
+5. Elixir (1.12+)
 
 Let's look at each in turn.
 
@@ -120,6 +121,14 @@ force the locale to UTF-8. For more information see:
 
 https://github.com/samaaron/sonic-pi/issues/2416 
 
+### 1.5 Install Elixir
+
+Lastly we just need to head over to the Elixir website and download and
+run the installer:
+
+https://elixir-lang.org/install.html#windows
+
+
 ## 2. Preparing the Build
 
 Once we have installed all the dependencies, we're now ready to build

app/linux-build-all.sh

@@ -2,11 +2,15 @@
 set -e # Quit script on error
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-cd ${SCRIPT_DIR}
 
+cd ${SCRIPT_DIR}
 "${SCRIPT_DIR}/linux-prebuild.sh"
+
+cd ${SCRIPT_DIR}
 "${SCRIPT_DIR}/linux-config.sh"
 
+
+cd ${SCRIPT_DIR}
 cd build
 cmake --build . --config Release
 

app/linux-prebuild.sh

@@ -47,6 +47,9 @@ PATH=`pkg-config --variable bindir Qt5`:$PATH lrelease "${SCRIPT_DIR}"/gui/qt/la
 
 echo "Compiling Erlang files..."
 cd "${SCRIPT_DIR}/server/erlang/tau"
-erl -make
+mix local.hex --force
+mix deps.get
+mix release
+
 cp src/tau.app.src ebin/tau.app
 cd "${SCRIPT_DIR}"

app/mac-build-all.sh

@@ -5,8 +5,10 @@ SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
 cd ${SCRIPT_DIR}
 
 "${SCRIPT_DIR}/mac-prebuild.sh"
+cd ${SCRIPT_DIR}
 "${SCRIPT_DIR}/mac-config.sh"
 
+cd ${SCRIPT_DIR}
 cd build
 cmake --build . --config Release
 

app/mac-prebuild.sh

@@ -82,8 +82,11 @@ echo "Updating GUI translation files..."
 # Use lrelease on PATH if available otherwise assume Qt was installed via homebrew
 PATH=$PATH:/usr/local/opt/qt@5/bin lrelease "${SCRIPT_DIR}"/gui/qt/lang/*.ts
 
-echo "Compiling Erlang files..."
+echo "Compiling Erlang/Elixir files..."
 cd "${SCRIPT_DIR}/server/erlang/tau"
-../../native/erlang/erl -make
+mix local.hex --force
+mix deps.get
+mix release
+
 cp src/tau.app.src ebin/tau.app
 cd "${SCRIPT_DIR}"

app/pi-build-all.sh

@@ -2,11 +2,14 @@
 set -e # Quit script on error
 
 SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-cd ${SCRIPT_DIR}
 
+cd ${SCRIPT_DIR}
 "${SCRIPT_DIR}/pi-prebuild.sh"
+
+cd ${SCRIPT_DIR}
 "${SCRIPT_DIR}/pi-config.sh"
 
+cd ${SCRIPT_DIR}
 cd build
 cmake --build . --config Release
 

app/server/erlang/tau/.formatter.exs

@@ -0,0 +1,4 @@
+# Used by "mix format"
+[
+  inputs: ["{mix,.formatter}.exs", "{config,lib,test}/**/*.{ex,exs}"]
+]