Merge pull request #188 from IlnurHA/master

Metric HOC

metrics/hoc.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+# The MIT License (MIT)
+#
+# Copyright (c) 2021-2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+set -e
+set -o pipefail
+
+java=$1
+output=$(realpath "$2")
+
+cd "$(dirname "${java}")"
+base=$(basename "${java}")
+
+# To check that file was added in commit any time
+if git status > /dev/null 2>&1 && test -n "$(git log --oneline -- "${base}")"; then
+    hoc=$(git log -L:"class\s:${java}" | grep -E "^[+-].*$" | grep -Ev "^\-\-\-\s\S+$" | grep -Evc "^\+\+\+\s\S+$")
+else
+    hoc=0
+fi
+
+echo "hoc ${hoc} Hits Of Code for file" > "${output}"

tests/metrics/test-hoc.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+# The MIT License (MIT)
+#
+# Copyright (c) 2021-2024 Yegor Bugayenko
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+set -e
+set -o pipefail
+
+temp=$1
+stdout=$2
+
+{
+    hoc_script_path="${LOCAL}/metrics/hoc.sh"
+    cd "${temp}"
+
+    rm -rf ./*
+    rm -rf .git
+
+    git init --quiet .
+    git config user.email 'foo@example.com'
+    git config user.name 'Foo'
+    git config commit.gpgsign false
+
+    java_dir="./foo/dir/"
+    java="FooTest.java"
+
+    mkdir -p "${java_dir}"
+    cd ${java_dir}
+
+    touch "${java}"
+    touch "stdout"
+
+    printf "class Foo {}" > "${java}"
+    git add "${java}"
+    git commit --quiet -m "first commit"
+    ${hoc_script_path} "${java}" "stdout"
+    grep "hoc 1" "stdout"
+
+    printf "class Foo {\n\tint x;\n\tbool y;\n}\n" > "${java}"
+    git add "${java}"
+    git commit --quiet -m "+second commit"
+    ${hoc_script_path} "${java}" "stdout"
+    grep "hoc 6" "stdout"
+
+    printf "class Foo {\n\tbool z;\n}\n" > "${java}"
+    git add "${java}"
+    git commit --quiet -m "-third commit"
+    ${hoc_script_path} "${java}" "stdout"
+    grep "hoc 9" "stdout"
+} > "${stdout}" 2>&1
+echo "👍🏻 Correctly calculated hits of code"