Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#5 New metric: age of class in hours #380

Merged
merged 14 commits into from
Oct 15, 2024
39 changes: 39 additions & 0 deletions metrics/aocih.sh
Original file line number Diff line number Diff line change
@@ -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_file=$1
output=$2

creation_timestamp=$(git log --diff-filter=A --format=%at -- "$java_file" | tail -1)
if [[ -z "$creation_timestamp" ]]; then
age_in_hours=0
else
current_timestamp=$(date +%s)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lueFlake "age of class in hours" is the number of hours since the date of birth of the repository. It has nothing to do with the current time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@yegor256 you mean difference between date of birth and date of class creation? i think i can redo it then

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lueFlake yes, like this:

A = C - D

Here, A is the age of file, C is the time when the file was first time added to the repo, and D is the time when the first file was added to the repo.

age_in_seconds=$((current_timestamp - creation_timestamp))
age_in_hours=$((age_in_seconds / 3600))
fi

echo "AoCiH $age_in_hours Age of the class in hours" > "$output"
50 changes: 50 additions & 0 deletions tests/metrics/test-aocih.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
#!/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

{
tmp=$(mktemp -d /tmp/XXXX)
"${LOCAL}/metrics/age_of_class.sh" "${tmp}/Test.java" "${temp}/stdout"
grep -q "AoCiH 0 " "${temp}/stdout"
} > "${stdout}" 2>&1
echo "👍🏻 Didn't fail in non-git directory"

{
mkdir -p "${temp}/foo"
cd "${temp}/foo"
git init --quiet .
git config user.email '[email protected]'
git config user.name 'Foo'
java="Test.java"
echo "class Foo {}" > "${java}"
git add "${java}"
git config commit.gpgsign false
git commit --quiet -am "Initial commit"
"${LOCAL}/metrics/age_of_class.sh" "${java}" stdout
grep -qP "AoCiH [^0]" stdout
} > "${stdout}" 2>&1
echo "👍🏻 Correctly calculated AoCiH in the repository"
Loading