Skip to content

Commit 3e2eddd

Browse files
author
edwmurph
committed
decent optimization; added last of test cases; fixed corner case; added some polish
1 parent 8221df2 commit 3e2eddd

8 files changed

+102
-100
lines changed

‎nvm.sh

+35-42
Original file line numberDiff line numberDiff line change
@@ -358,13 +358,13 @@ nvm_normalize_semver() {
358358
s/ ?- ?/ - /g;
359359
360360
# ' 1 ' => ' 1.x.x '
361-
# ' x ' => ' x.x.x '
362-
s/ ([0-9]+|x) / \1.x.x /g;
361+
# ' ~x ' => ' ~x.x.x '
362+
s/ (~|\^)?([0-9]+|x) / \1\2.x.x /g;
363363
364364
# ' 1.2 ' => ' 1.2.x '
365-
# ' 1.x ' => ' 1.x.x '
366-
# ' x.x ' => ' x.x.x '
367-
s/ (([0-9]+|x)\.([0-9]+|x)) / \1.x /g;
365+
# ' ~1.x ' => ' ~1.x.x '
366+
# ' ^x.x ' => ' ^x.x.x '
367+
s/ (~|\^)?(([0-9]+|x)\.([0-9]+|x)) / \1\2.x /g;
368368
369369
# ' 1.2.3 - 1.2.4 ' => ' >=1.2.3 <=1.2.4 '
370370
s/ (([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x)) ?\- ?(([0-9]+|x)\.([0-9]+|x)\.([0-9]+|x)) / >=\1 <=\5 /g;
@@ -387,9 +387,11 @@ nvm_normalize_semver() {
387387
# ` ^0.0.1 ` => ` >=0.0.1 <0.0.2 `
388388
# ` ^0.1.2 ` => ` >=0.1.2 <0.2.0 `
389389
# ` ^1.2.3 ` => ` >=1.2.3 <2.0.0 `
390+
# ` ^1.0.0 ` => ` >=1.0.0 <2.0.0 `
390391
# ` ~0.0.1 ` => ` >=0.0.1 <0.1.0 `
391392
# ` ~0.1.2 ` => ` >=0.1.2 <0.2.0 `
392393
# ` ~1.2.3 ` => ` >=1.2.3 <1.3.0 `
394+
# ` ~1.0.0 ` => ` >=1.0.0 <2.0.0 `
393395
# ` x.x.x ` => ` >0.0.0 `
394396
# ` x.x.1 ` => ` >0.0.0 `
395397
# ` x.1.x ` => ` >0.0.0 `
@@ -438,7 +440,11 @@ nvm_normalize_semver() {
438440
output=output ">=" version " <" a[1]+1 ".0.0 ";
439441
}
440442
} else if ( match(comparator, /^~/) ) {
441-
if ( match(comparator, /^~0.0.[0-9]+$/) ) {
443+
if ( match(comparator, /^~[0-9]+.0.0$/) ) {
444+
version=substr(comparator,2)
445+
split(version, a, /\./)
446+
output=output ">=" version " <" a[1]+1 ".0.0 "
447+
} else if ( match(comparator, /^~0.0.[0-9]+$/) ) {
442448
version=substr(comparator,2)
443449
split(version, a, /\./)
444450
output=output ">=" version " <0." a[2]+1 ".0 "
@@ -472,9 +478,9 @@ nvm_normalize_semver() {
472478

473479
if nvm_is_normalized_semver "$validated_semver"; then
474480
command printf '%s' "$validated_semver"
475-
else
476-
return 1
481+
return 0
477482
fi
483+
return 1
478484
}
479485

480486
# Given a semver and version list, find the highest compatible version by doing the following:
@@ -490,19 +496,18 @@ nvm_interpret_complex_semver() {
490496
fi
491497

492498
# For each comparator_set in the semver:
493-
# - Resolve the comparator_set to its newest compatible version.
494-
# - Add the discovered newest compatible version to highest_compatible_versions.
495-
# - Choose the highest version among all the versions collected in highest_compatible_versions.
499+
# - Try to resolve the comparator_set to its newest compatible version.
500+
# - But stop looking for a compatible version for a comparator_set if the current_version being iterated on is lower than an already found compatible version.
501+
# - If by the end of the algorithm, a version other than 0.0.0 is collected in highest_compatible_version, output that version.
496502
semver=$(command printf '%s' "$semver" | command tr '||' '\n')
497503
local version_list_copy
498504
local current_comparator_set
499505
local current_version
500506
local current_comparator_set_copy
501507
local current_comparator
502508
local stripped_version_from_comparator
503-
local highest_compatible_versions
504-
# TODO make this just always store the highest possible compatible version
505-
highest_compatible_versions=''
509+
local highest_compatible_version
510+
highest_compatible_version='0.0.0'
506511

507512
while [ -n "$semver" ]; do
508513
version_list_copy=$(command printf '%s' "$version_list")
@@ -511,13 +516,17 @@ nvm_interpret_complex_semver() {
511516
[ -n "$current_comparator_set" ] || continue
512517

513518
# For each version in the version_list_copy (iterating from newest to oldest):
514-
# - If current_version satisfies all comparators in current_comparator_set, we've found the newest version compatible with all comparators in current current_comparator_set.
515-
# - Add discovered version to highest_compatible_versions and stop iterating through versions for current_comparator_set.
519+
# - If current_version satisfies all comparators in current_comparator_set, we've found the newest highest version compatible with all comparators in current current_comparator_set.
520+
# - Store the current_version in highest_compatible_version and stop iterating through versions for current_comparator_set.
516521
while [ -n "$version_list_copy" ]; do
517522
current_version=$(command printf '%s' "$version_list_copy" | command tail -n1 | command sed -E 's/^ +//;s/ +$//' | nvm_grep -o '^[0-9]\+\.[0-9]\+\.[0-9]\+$')
518523
version_list_copy=$(command printf '%s' "$version_list_copy" | command sed '$d')
519524
[ -n "$current_version" ] || continue
520-
# TODO if current_version is less than the highest version in highest_compatile_versions, no need to continue
525+
if [ "$highest_compatible_version" != '0.0.0' ] && nvm_version_greater "$highest_compatible_version" "$current_version"; then
526+
# If we previously found a compatible version that is higher than the current_version, there is no need to continue checking versions.
527+
version_list_copy=''
528+
continue
529+
fi
521530

522531
# For each comparator in the current_comparator_set_copy:
523532
# - If current_version is compatible with all comparators, we know current_version is the newest compatible version
@@ -537,7 +546,7 @@ nvm_interpret_complex_semver() {
537546
# current_comparator is looking for an exact match, and the current_version is the exact match, so this current_comparator is satisfied.
538547
if [ -z "$current_comparator_set_copy" ]; then
539548
# Also, this is the last comparator in the current_comparator_set_copy so we can assume we've found the newest compatible version of the current_comparator_set.
540-
highest_compatible_versions="$highest_compatible_versions $current_version"
549+
highest_compatible_version="$current_version"
541550
version_list_copy=''
542551
fi
543552
elif nvm_version_greater "$stripped_version_from_comparator" "$current_version"; then
@@ -554,7 +563,7 @@ nvm_interpret_complex_semver() {
554563
# current_version is less than or equal to the current_comparator version number so this current_comparator is satisfied.
555564
if [ -z "$current_comparator_set_copy" ]; then
556565
# Also, this is the last comparator in the current_comparator_set_copy so we can assume we've found the newest compatible version of the current_comparator_set.
557-
highest_compatible_versions="$highest_compatible_versions $current_version"
566+
highest_compatible_version="$current_version"
558567
version_list_copy=''
559568
fi
560569
else
@@ -567,7 +576,7 @@ nvm_interpret_complex_semver() {
567576
# current_version is greater than or equal to the current_comparator version number so this current_comparator is satisfied.
568577
if [ -z "$current_comparator_set_copy" ]; then
569578
# Also, this is the last comparator in the current_comparator_set_copy so we can assume we've found the newest compatible version of the current_comparator_set.
570-
highest_compatible_versions="$highest_compatible_versions $current_version"
579+
highest_compatible_version="$current_version"
571580
version_list_copy=''
572581
fi
573582
else
@@ -581,7 +590,7 @@ nvm_interpret_complex_semver() {
581590
# current_version is less than the current_comparator version number so this current_comparator is satisfied.
582591
if [ -z "$current_comparator_set_copy" ]; then
583592
# Also, this is the last comparator in the current_comparator_set_copy so we can assume we've found the newest compatible version of the current_comparator_set.
584-
highest_compatible_versions="$highest_compatible_versions $current_version"
593+
highest_compatible_version="$current_version"
585594
version_list_copy=''
586595
fi
587596
else
@@ -594,7 +603,7 @@ nvm_interpret_complex_semver() {
594603
# current_version is greater than the current_comparator version number so this current_comparator is satisfied.
595604
if [ -z "$current_comparator_set_copy" ];then
596605
# Also, this is the last comparator in the current_comparator_set_copy so we can assume we've found the newest compatible version of the current_comparator_set.
597-
highest_compatible_versions="$highest_compatible_versions $current_version"
606+
highest_compatible_version="$current_version"
598607
version_list_copy=''
599608
fi
600609
else
@@ -610,27 +619,11 @@ nvm_interpret_complex_semver() {
610619
done # while [ -n "$version_list_copy" ]; do
611620
done # while [ -n "$semver" ]; do
612621

613-
# Iterate through each of the versions in highest_compatible_versions, which are the highest versions that satisfy each of the comparator sets.
614-
# Since comparator sets are separated by '||', choosing any of the highest versions compatible with any of the comparator_sets would be compatible with the whole semver.
615-
# Therefore, we should resolve to the highest version in highest_compatible_versions.
616-
local highest_compatible_version
617-
local compatible_node_version
618-
highest_compatible_version='0.0.0'
619-
highest_compatible_versions=$(command printf '%s' "$highest_compatible_versions" | command tr ' ' '\n')
620-
while [ -n "$highest_compatible_versions" ]; do
621-
compatible_node_version=$(command printf '%s' "$highest_compatible_versions" | command head -n1 | command sed -E 's/^ +//;s/ +$//')
622-
highest_compatible_versions=$(command printf '%s' "$highest_compatible_versions" | command tail -n +2)
623-
[ -n "$compatible_node_version" ] || continue
624-
625-
if nvm_version_greater "$compatible_node_version" "$highest_compatible_version"; then
626-
highest_compatible_version="$compatible_node_version"
627-
fi
628-
done
629-
if [ "$highest_compatible_version" != '0.0.0' ]; then
622+
if [ -n "$highest_compatible_version" ] && [ "$highest_compatible_version" != '0.0.0' ]; then
630623
command printf '%s' "$highest_compatible_version"
631-
else
632-
return 1
624+
return 0
633625
fi
626+
return 1
634627
}
635628

636629
# Given a semver and version list, optimize discovery of highest compatible version with this function which quickly interprets some common semvers.
@@ -677,7 +670,7 @@ nvm_interpret_simple_semver() {
677670
command printf '%s' "$newest_version_from_list"
678671
return 0
679672
else
680-
# TODO we know it's not worth doing the complex semver interpretation at this point
673+
command printf '%s' 'STOP' # we have determined no node version will be compatible with the semver
681674
return 1
682675
fi
683676

‎test/fast/Unit tests/nvm_get_node_from_pkg_json

+27-25
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
\. ../../../nvm.sh
44
\. ../../generated_semvers.sh
55

6+
# This test suite validates the behavior of extracting the semver from a package.json's engine.node value given valid/invalid semvers and valid/invalid json structures.
67

7-
# POSITIVE TEST CASES
8-
9-
10-
# (TEST SET #1) uses valid TEST_SEMVER's and valid package.json templates
8+
# (TEST 1 POSITIVE TEST CASES)
9+
# SEMVERS: valid
10+
# PACKAGE.JSON TEMPLATES: invalid
1111
test_cases="$VALID_SEMVERS_FOR_PKG_JSON"
1212
if [ -z "$test_cases" ]; then
13-
die 'TEST SET 1 for nvm_get_node_from_pkg_json given an empty set of test cases'
13+
die 'TEST 1 for nvm_get_node_from_pkg_json given an empty set of test cases'
1414
fi
1515
prev_semver=''
1616
for template_file_name in package_json_templates/_valid_*; do
@@ -21,26 +21,24 @@ for template_file_name in package_json_templates/_valid_*; do
2121
expectedOutput=$(nvm_trim_and_reduce_whitespace_to_one_space "$semver")
2222

2323
if [ "$prev_semver" = "$semver" ]; then
24-
die "Problem iterating through test_cases (TEST SET #1). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
24+
die "Problem iterating through test_cases (TEST 1). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
2525
fi
2626
prev_semver="$semver"
2727

2828
pkg_json_contents=$(sed "s/NODE_SEMVER/$semver/g" "$template_file_name" | tail -n +3)
2929
actual_output=$(nvm_get_node_from_pkg_json "$pkg_json_contents")
3030
if [ "$actual_output" != "$expectedOutput" ] || [ -z "$actual_output" ] || [ -z "$pkg_json_contents" ]; then
31-
die "'nvm_get_node_from_pkg_json' POSITIVE test case failed (TEST SET #1). Expected '$expectedOutput' but got '$actual_output' when given input '$semver' and template '$template_file_name':\n$pkg_json_contents"
31+
die "'nvm_get_node_from_pkg_json' POSITIVE test case failed (TEST 1). Expected '$expectedOutput' but got '$actual_output' when given input '$semver' and template '$template_file_name':\n$pkg_json_contents"
3232
fi
3333
done
3434
done
3535

36-
37-
# NEGATIVE TEST CASES
38-
39-
40-
# (TEST SET #2) uses valid TEST_SEMVER's but invalid package.json templates
36+
# (TEST 2 NEGATIVE TEST CASES)
37+
# SEMVERS: valid
38+
# PACKAGE.JSON TEMPLATES: invalid
4139
test_cases="$VALID_SEMVERS_FOR_PKG_JSON"
4240
if [ -z "$test_cases" ]; then
43-
die 'TEST SET 2 for nvm_get_node_from_pkg_json given an empty set of test cases'
41+
die 'TEST 2 for nvm_get_node_from_pkg_json given an empty set of test cases'
4442
fi
4543
prev_semver=''
4644
for template_file_name in package_json_templates/_invalid_*; do
@@ -50,23 +48,25 @@ for template_file_name in package_json_templates/_invalid_*; do
5048
[ -n "$semver" ] || continue
5149

5250
if [ "$prev_semver" = "$semver" ]; then
53-
die "Problem iterating through test_cases (TEST SET #2). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
51+
die "Problem iterating through test_cases (TEST 2). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
5452
fi
5553
prev_semver="$semver"
5654

5755
pkg_json_contents=$(sed "s/NODE_SEMVER/$semver/g" "$template_file_name" | tail -n +3)
5856
actual_output=$(nvm_get_node_from_pkg_json "$pkg_json_contents")
5957
if [ "$actual_output" != "" ] || [ -z "$semver" ] || [ -z "$pkg_json_contents" ]; then
60-
die "'nvm_get_node_from_pkg_json' NEGATIVE test case failed (TEST SET #2). Expected to get empty string but got '$actual_output' when given input template '$template_file_name':\n$pkg_json_contents"
58+
die "'nvm_get_node_from_pkg_json' NEGATIVE test case failed (TEST 2). Expected to get empty string but got '$actual_output' when given input template '$template_file_name':\n$pkg_json_contents"
6159
fi
6260
done
6361
done
6462

6563

66-
# (TEST SET #3) uses invalid TEST_SEMVER's but valid package.json templates
64+
# (TEST 3 NEGATIVE TEST CASES)
65+
# SEMVERS: invalid
66+
# PACKAGE.JSON TEMPLATES: valid
6767
test_cases="$INVALID_SEMVERS_FOR_PKG_JSON"
6868
if [ -z "$test_cases" ]; then
69-
die 'TEST SET 3 for nvm_get_node_from_pkg_json given an empty set of test cases'
69+
die 'TEST 3 for nvm_get_node_from_pkg_json given an empty set of test cases'
7070
fi
7171
prev_semver=''
7272
for template_file_name in package_json_templates/_valid_*; do
@@ -76,22 +76,24 @@ for template_file_name in package_json_templates/_valid_*; do
7676
test_cases=$(echo "$test_cases" | tail -n +2)
7777

7878
if [ "$prev_semver" = "$semver" ]; then
79-
die "Problem iterating through test_cases (TEST SET #3). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
79+
die "Problem iterating through test_cases (TEST 3). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
8080
fi
81-
prev_semver=$(printf "%s" "$semver")
81+
prev_semver="$semver"
8282

8383
pkg_json_contents=$(sed "s/NODE_SEMVER/$semver/g" "$template_file_name" | tail -n +3)
8484
actual_output=$(nvm_get_node_from_pkg_json "$pkg_json_contents")
8585
if [ "$actual_output" != "" ] || [ -z "$semver" ] || [ -z "$pkg_json_contents" ]; then
86-
die "'nvm_get_node_from_pkg_json' NEGATIVE test case failed (TEST SET #3). Expected to get empty string but got '$actual_output' when given input template '$template_file_name':\n$pkg_json_contents"
86+
die "'nvm_get_node_from_pkg_json' NEGATIVE test case failed (TEST 3). Expected to get empty string but got '$actual_output' when given input template '$template_file_name':\n$pkg_json_contents"
8787
fi
8888
done
8989
done
9090

91-
# (TEST SET #4) uses invalid TEST_SEMVER's and invalid package.json templates
91+
# (TEST 4 NEGATIVE TEST CASES)
92+
# SEMVERS: invalid
93+
# PACKAGE.JSON TEMPLATES: invalid
9294
test_cases="$INVALID_SEMVERS_FOR_PKG_JSON"
9395
if [ -z "$test_cases" ]; then
94-
die 'TEST SET 4 for nvm_get_node_from_pkg_json given an empty set of test cases'
96+
die 'TEST 4 for nvm_get_node_from_pkg_json given an empty set of test cases'
9597
fi
9698
prev_semver=''
9799
for template_file_name in package_json_templates/_invalid_*; do
@@ -101,14 +103,14 @@ for template_file_name in package_json_templates/_invalid_*; do
101103
test_cases=$(echo "$test_cases" | tail -n +2)
102104

103105
if [ "$prev_semver" = "$semver" ]; then
104-
die "Problem iterating through test_cases (TEST SET #4). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
106+
die "Problem iterating through test_cases (TEST 4). Encountered the same value twice in a row. prev_semver='$prev_semver' semver='$semver'.\n"
105107
fi
106-
prev_semver=$(printf "%s" "$semver")
108+
prev_semver="$semver"
107109

108110
pkg_json_contents=$(sed "s/NODE_SEMVER/$semver/g" "$template_file_name" | tail -n +3)
109111
actual_output=$(nvm_get_node_from_pkg_json "$pkg_json_contents")
110112
if [ "$actual_output" != "" ] || [ -z "$semver" ] || [ -z "$pkg_json_contents" ]; then
111-
die "'nvm_get_node_from_pkg_json' NEGATIVE test case failed (TEST SET #4). Expected to get empty string but got '$actual_output' when given input template '$template_file_name':\n$pkg_json_contents"
113+
die "'nvm_get_node_from_pkg_json' NEGATIVE test case failed (TEST 4). Expected to get empty string but got '$actual_output' when given input template '$template_file_name':\n$pkg_json_contents"
112114
fi
113115
done
114116
done

‎test/fast/Unit tests/nvm_is_normalized_semver

+1-9
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,13 @@
33
\. ../../../nvm.sh
44
\. ../../generated_semvers.sh
55

6-
# nvm_is_normalized_semver validates that given semvers adhere to the following grammer
7-
#
8-
# semver ::= comparator_set ( ' || ' comparator_set )*
9-
# comparator_set ::= comparator ( ' ' comparator )*
10-
# comparator ::= ( '<' | '<=' | '>' | '>=' | '' ) [0-9]+ '.' [0-9]+ '.' [0-9]+
6+
# nvm_is_normalized_semver validates that a given semver adheres to a particular grammar. See grammar with definition of function nvm_is_normalized_semver() in nvm.sh.
117

128
# POSITIVE TEST CASES
13-
149
positive_test_cases="$VALID_NORMALIZED_SEMVERS"
1510
if [ -z "$positive_test_cases" ]; then
1611
die 'positive test cases are empty'
1712
fi
18-
1913
prev_semver=''
2014
while [ -n "$positive_test_cases" ]; do
2115
semver=$(echo "$positive_test_cases" | head -n1)
@@ -30,12 +24,10 @@ while [ -n "$positive_test_cases" ]; do
3024
done
3125

3226
# NEGATIVE TEST CASES
33-
3427
negative_test_cases=$(printf "%s\n%s" "$VALID_NON_NORMALIZED_SEMVERS" "$INVALID_SEMVERS_FOR_PKG_JSON")
3528
if [ -z "$negative_test_cases" ]; then
3629
die 'negative test cases are empty'
3730
fi
38-
3931
prev_semver='initialized to non empty string'
4032
while [ -n "$negative_test_cases" ]; do
4133
semver=$(echo "$negative_test_cases" | head -n1)

‎test/fast/Unit tests/nvm_normalize_semver

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
\. ../../../nvm.sh
44
\. ../../generated_semvers.sh
55

6+
# This test suite validates the behavior of normalizing a semver from its raw form to a specific grammar. See the grammar defined with nvm_is_normalized_semver() in nvm.sh.
7+
68
# TEST 1: Validate that for already normalized semvers, nvm_normalize_semver outputs the same semver.
79
test_cases="$VALID_NORMALIZED_SEMVERS"
810
if [ -z "$test_cases" ]; then

‎test/fast/Unit tests/nvm_string_contains_regexp

+2-4
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
\. ../../../nvm.sh
44
\. ../../generated_semvers.sh
5-
65
normalized_semver_regexp='^( ?(<|<=|>|>=)?[0-9]+\.[0-9]+\.[0-9]+)+( \|\| ( ?(<|<=|>|>=)?[0-9]+\.[0-9]+\.[0-9]+)+)*$'
76

8-
# POSITIVE TEST CASES
7+
# Validates the behavior of nvm_string_contains_regexp() which returns 0 if the given string contains the given regular expression.
98

9+
# POSITIVE TEST CASES
1010
test_cases="$VALID_NORMALIZED_SEMVERS"
1111
while [ -n "$test_cases" ]; do
1212
string=$(echo "$test_cases" | head -n1)
@@ -17,10 +17,8 @@ while [ -n "$test_cases" ]; do
1717
done
1818

1919
# NEGATIVE TEST CASES
20-
2120
# string:regexp
2221
test_cases=$(printf "%s\n%s" "$VALID_NON_NORMALIZED_SEMVERS" "$INVALID_SEMVERS_FOR_PKG_JSON")
23-
2422
while [ -n "$test_cases" ]; do
2523
string=$(echo "$test_cases" | head -n1)
2624
if [ -z "$normalized_semver_regexp" ] || nvm_string_contains_regexp "$string" "$normalized_semver_regexp"; then

0 commit comments

Comments
 (0)