Merge remote-tracking branch 'upstream' into GEN-202/fixup-deploy

Author: obscurerichard

.ci/travis/bootstrap.sh

@@ -0,0 +1,98 @@
+#!/usr/bin/env bash
+
+# Sets some Bash options to encourage well formed code.
+# For example, some of the options here will cause the script to terminate as
+# soon as a command fails. Another option will cause an error if an undefined
+# variable is used.
+# See: https://www.gnu.org/software/bash/manual/html_node/The-Set-Builtin.html
+
+# Any trap on ERR is inherited by shell functions, command substitutions, and
+# commands executed in a subshell environment. The ERR trap is normally not
+# inherited in such cases.
+set -o errtrace
+
+# Any trap on DEBUG and RETURN are inherited by shell functions, command
+# substitutions, and commands executed in a subshell environment. The DEBUG and
+# RETURN traps are normally not inherited in such cases.
+set -o functrace
+
+# Exit if any command exits with a non-zero exit status.
+set -o errexit
+
+# Exit if script uses undefined variables.
+set -o nounset
+
+# Prevent masking an error in a pipeline.
+# Look at the end of the 'Use set -e' section for an excellent explanation.
+# see: https://www.davidpashley.com/articles/writing-robust-shell-scripts/
+set -o pipefail
+
+# Make debugging easier when you use `set -x`
+# See: http://wiki.bash-hackers.org/scripting/debuggingtips#making_xtrace_more_useful
+export PS4='+(${BASH_SOURCE}:${LINENO}): ${FUNCNAME[0]:+${FUNCNAME[0]}(): }'
+
+# If using Travis, output is 0, else 1
+function using_travis {
+  if [[ "${TRAVIS:-}" == "true" ]]; then
+    echo 0
+  else
+    echo 1
+  fi
+}
+
+# If using Linux, output is 'linux'
+# If using OSX, output is 'osx'
+function get_os {
+  local -i on_travis
+  local os
+  on_travis=$(using_travis)
+
+  if [[ $on_travis -eq 0 ]]; then
+    printf "%s" "$TRAVIS_OS_NAME"
+  else
+    os="$(uname)"
+    case "$os" in
+      Darwin)
+        printf "osx"
+        ;;
+
+      Linux)
+        printf "linux"
+        ;;
+
+      *)
+        echo "ERROR: Unsupported platform '$os'"
+        set -x && exit 1
+        ;;
+    esac
+  fi
+}
+
+function get_merge_release_filename {
+  shopt -s nocasematch
+  local pattern
+  pattern="(gen[^0-9]+[0-9]+)[^0-9]*"
+  if [[ "${TRAVIS_COMMIT_MESSAGE:-}" =~ $pattern ]]; then
+    local jira_ticket_id
+    # convert to upper case.
+    # NOTE: don't use anything fancy here since osx on Travis uses Bash 3.x so
+    #       version 4.x's way of doing this won't work here.
+    jira_ticket_id=$(echo "${BASH_REMATCH[1]}" | tr '[:lower:]' '[:upper:]')
+    jira_ticket_id="${jira_ticket_id}.app"
+    echo "${jira_ticket_id// /-}" # replace spaces with hyphens
+  else
+    echo "ERROR: Unable to get JIRA branch name from the merge to master."
+    set -x && exit 1
+  fi
+}
+
+function get_release_filename {
+  if [[ "${TRAVIS_BRANCH:-}" == "master" ]]; then
+    # On merge to 'master', generate [jira_ticket_id].app.tgz release.
+    # Ticket name can safely be assumed based on the regexp /(gen[^0-9]+[0-9]+)/i.
+    printf "%s" "$(get_merge_release_filename)"
+  elif [[ -n "${TRAVIS_TAG:-}" ]]; then
+    # On tag, generate [GIT_TAG].tgz release
+    printf "%s" "${TRAVIS_TAG}"
+  fi
+}

.ci/travis/create_release.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+# This script should be used to make preparations to run the 'script' lifecycle.
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+# shellcheck source=./.ci/travis/bootstrap.sh
+source "$DIR"/bootstrap.sh
+
+if [[ "${TRAVIS_BRANCH:-}" != "master" ]] && [[ -z "${TRAVIS_TAG:-}" ]]; then
+  echo "ERROR: This is not being merged into master and no tag is present."
+  exit 1
+fi
+
+declare release_filename
+release_filename=$(get_release_filename)
+
+mv "${TRAVIS_BUILD_DIR}/build/release.tgz"  "${TRAVIS_BUILD_DIR}/build/${release_filename}.tgz"

.ci/travis/install_deps.sh

@@ -0,0 +1,45 @@
+#!/usr/bin/env bash
+
+# This script should be used to install build dependencies.
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+# shellcheck source=./.ci/travis/bootstrap.sh
+source "$DIR"/bootstrap.sh
+
+declare os
+os="$(get_os)"
+
+case "$os" in
+  osx)
+    brew install shellcheck
+    ;;
+
+  *)
+    echo "ERROR: Unsupported platform '$os'"
+    set -x && exit 1
+    ;;
+esac
+
+# If you have a highly customized ~/.ssh/config file, you might find setting
+# this variable very useful if you want to run this script locally.
+#
+# For example:
+#   $ cat ~/.ssh/config
+#
+#   Host github.com
+#     HostName github.com
+#     User git
+#     IdentityFile ~/.ssh/id_rsa.pub
+#
+#   Host github.com-alternative
+#     HostName github.com
+#     User git
+#     IdentityFile ~/.ssh/id_rsa-alternative.pub
+#
+# You can now do:
+#   $ GEN_GITHUB_HOSTNAME=github.com-alternative ./before_install.sh
+# That will cause Git to use the '~/.ssh/id_rsa-alternative.pub' key.
+if [[ -z "${GEN_GITHUB_HOSTNAME:-}" ]]; then
+  GEN_GITHUB_HOSTNAME="github.com"
+fi
+git clone git@"$GEN_GITHUB_HOSTNAME":ModusCreateOrg/creative-engine.git

.ci/travis/lint.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# This script should be used to make preparations to run the 'script' lifecycle.
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+# shellcheck source=./.ci/travis/bootstrap.sh
+source "$DIR"/bootstrap.sh
+
+shellcheck --version
+
+# Running in a subshell to avoid cd'ing back and forth.
+(
+  pushd "$DIR/../../" > /dev/null
+  # Look for all files with a '.sh' extension, excluding the 'creative-engine'
+  # dir. Run shellcheck against those files
+  find \
+    . \
+    -path ./creative-engine \
+    -prune -o \
+    -name '*.sh' \
+    -exec \
+      bash -c \
+        'shellcheck --external-sources "$1"' \
+    -- {} \;
+)

.gitignore

@@ -2,8 +2,9 @@
 .*
 ~*
 
-# Include the Travis build config
+# Include the Travis build config and its scripts
 !.travis.yml
+!.ci
 
 # ignore node/grunt dependency directories
 node_modules/
@@ -93,3 +94,4 @@ src/Resources.h
 sdkconfig
 sdkconfig.old
 *.store
+*.tmp

.travis.yml

@@ -1,8 +1,13 @@
-sudo: enabled
+---
 os: osx
 language: cpp
-before_install: git clone git@github.com:ModusCreateOrg/creative-engine.git
-script: "./scripts/build.sh"
+sudo: enabled
+git:
+  depth: 1
+install: ./.ci/travis/install_deps.sh
+before_script: ./.ci/travis/lint.sh
+script: ./scripts/build.sh
+before_deploy: ./.ci/create_release.sh
 deploy:
   provider: releases
   skip_cleanup: true
@@ -12,3 +17,13 @@ deploy:
   on:
     tags: true
     repo: ModusCreateOrg/genus
+  file_glob: true
+  file: build/*.tgz
+  skip_cleanup: true
+  overwrite: true
+  on:
+    tags: true 
+    repo: ModusCreateOrg/genus
+    # create release on merge to 'master' and on a tag.
+    condition: $TRAVIS_BRANCH == "master" || -n $TRAVIS_TAG
+    # TODO: Post to Slack

CMakeLists.txt

@@ -7,35 +7,51 @@ set(CMAKE_VERBOSE_MAKEFILE ON)
 
 # creative-engine path
 if (EXISTS $ENV{CREATIVE_ENGINE_PATH})
-    # set ENV variable in CLion project settings
-    set(CREATIVE_ENGINE_PATH $ENV{CREATIVE_ENGINE_PATH})
-    message(STATUS "Using user-defined creative-engine path: ${CREATIVE_ENGINE_PATH}")
-else()
+   # set ENV variable in CLion project settings
+   set(CREATIVE_ENGINE_PATH $ENV{CREATIVE_ENGINE_PATH})
+#   message(STATUS "********************************* Using user-defined creative-engine path: ${CREATIVE_ENGINE_PATH}")
+else ()
     set(CREATIVE_ENGINE_PATH "${CMAKE_SOURCE_DIR}/../creative-engine")
-    message(STATUS "Falling back to default creative-engine path: ${CREATIVE_ENGINE_PATH}")
-endif()
+#   message(STATUS "<<<<<<<<<<<<<<<<<<<<<<<<<< Falling back to default creative-engine path: ${CREATIVE_ENGINE_PATH}")
+endif ()
 
 # resource compiler
 set(RCOMP "${CREATIVE_ENGINE_PATH}/tools/rcomp")
 
 INCLUDE_DIRECTORIES(
-    ${SDL2_INCLUDE_DIRS}
-    ${SDL2IMAGE_INCLUDE_DIRS}
-    ${CMAKE_SOURCE_DIR}/src
-    ${CMAKE_CURRENT_SOURCE_DIR}/src
-    ${CMAKE_BINARY_DIR} /usr/local/include
-    ${CREATIVE_ENGINE_PATH}/src
-    ${CREATIVE_ENGINE_PATH}/src/Widgets
-    ${CREATIVE_ENGINE_PATH}/src/libxmp
-    ${CREATIVE_ENGINE_PATH}/src/libxmp/loaders
-    ${CREATIVE_ENGINE_PATH}/src/libxmp/loaders/prowizarde
+        ${SDL2_INCLUDE_DIRS}
+        ${SDL2IMAGE_INCLUDE_DIRS}
+        ${CMAKE_SOURCE_DIR}/src
+        ${CMAKE_SOURCE_DIR}/src/GameState
+        ${CMAKE_SOURCE_DIR}/src/GameState/Playfields
+        ${CMAKE_SOURCE_DIR}/src/GameState/Powerups
+        ${CMAKE_SOURCE_DIR}/src/GameOverState
+        ${CMAKE_SOURCE_DIR}/src/HighScoresState
+        ${CMAKE_SOURCE_DIR}/src/MainMenuState
+        ${CMAKE_SOURCE_DIR}/src/MainOptionsState
+        ${CMAKE_SOURCE_DIR}/src/SplashState
+        ${CMAKE_SOURCE_DIR}/src/RulesState
+        ${CMAKE_BINARY_DIR} /usr/local/include
+        ${CREATIVE_ENGINE_PATH}/src
+        ${CREATIVE_ENGINE_PATH}/src/Widgets
+        ${CREATIVE_ENGINE_PATH}/src/libxmp
+        ${CREATIVE_ENGINE_PATH}/src/libxmp/loaders
+        ${CREATIVE_ENGINE_PATH}/src/libxmp/loaders/prowizarde
 )
 
 # external libraries
 INCLUDE(FindPkgConfig)
 PKG_SEARCH_MODULE(SDL2 REQUIRED sdl2)
 PKG_SEARCH_MODULE(SDL2IMAGE REQUIRED SDL2_image>=2.0.0)
 
+# include creative-engine sources
+# when using out-of-tree source paths add_subdirectory's build_dir argument is required
+# use the project's current build directory
+# https://cmake.org/cmake/help/latest/variable/CMAKE_CURRENT_BINARY_DIR.html
+# https://cmake.org/cmake/help/latest/command/add_subdirectory.html
+# https://stackoverflow.com/questions/35260552/how-do-i-explicitly-specify-an-out-of-tree-source-in-cmake
+add_subdirectory(${CREATIVE_ENGINE_PATH} ${CMAKE_CURRENT_BINARY_DIR}/creative-engine)
+
 # build rcomp
 add_custom_command(
         OUTPUT rcomp
@@ -58,25 +74,23 @@ file(GLOB_RECURSE CREATIVE_ENGINE ${CREATIVE_ENGINE_PATH}/src/*.cpp)
 
 # gather LibXMP sources
 add_compile_definitions(LIBXMP_CORE_PLAYER=true)
-add_compile_definitions(LIBXMP_CORE_DISABLE_IT=true)
+
 file(
         GLOB LIBXMP_SRC
-        ${CREATIVE_ENGINE_PATH}/src/libxmp/loaders/*.h
         ${CREATIVE_ENGINE_PATH}/src/libxmp/loaders/*.c
-        ${CREATIVE_ENGINE_PATH}/src/libxmp/*.h
         ${CREATIVE_ENGINE_PATH}/src/libxmp/*.c
 )
 
 # gather Genus sources
 file(GLOB_RECURSE GENUS_SRC RELATIVE ${CMAKE_SOURCE_DIR} "src/*.cpp")
 
 add_executable(
-        genus
-        Resources.bin
-        ${LIBXMP_SRC}
-        ${CREATIVE_ENGINE}
-        ${GENUS_SRC}
-        )
+    genus
+    Resources.bin
+    ${LIBXMP_SRC}
+    ${CREATIVE_ENGINE}
+    ${GENUS_SRC}
+)
 
 # make genus.app
 if (APPLE)

Makefile

@@ -11,8 +11,11 @@ GENUS_STATES=$(GENUS_SRC_PATH)/GameState
 GENUS_STATES+=$(GENUS_SRC_PATH)/HighScoreState
 GENUS_STATES+=$(GENUS_SRC_PATH)/MainOptionsState
 GENUS_STATES+=$(GENUS_SRC_PATH)/SplashState
+GENUS_STATES+=$(GENUS_SRC_PATH)/CreditsState
 
-EXTRA_COMPONENT_DIRS=${CREATIVE_ENGINE_PATH} ${PROJECT_PATH}/src $(GENUS_STATES)
+GENUS_POWERUPS=$(GENUS_SRC_PATH)/GameState/Powerups
+
+EXTRA_COMPONENT_DIRS=${CREATIVE_ENGINE_PATH} ${PROJECT_PATH}/src $(GENUS_STATES) $(GENUS_POWERUPS)
 
 include $(IDF_PATH)/make/project.mk
 
@@ -38,6 +41,10 @@ resources: rcomp FORCE
 	echo "Compiling resources"
 	cd src && ${CREATIVE_ENGINE_PATH}/tools/rcomp Resources.r
 
+reset: FORCE
+	echo "Resetting high score table (and options)"
+	 rm -f cmake-build-debug/genus.app/Contents/MacOS/*.store
+
 FORCE: