Gun variants: Better common token & dupe checking

Require at least 3 letters for common tokens, with some explicit
exceptions. It might be worth going to 4 letters, but going to 3 cleaned
up some issues.

Also make the dupe check an actual error (resulting in test failure)
than just a silent one.

The guns caught by the dupe check are allowed as separate by the variant
criteria, but it may be being too lenient there and they should instead
be combined.

Fix the errors that surfaced.
- two guns had 16" and 20" barrels, name the longer one long-barreled
- Two revolvers (chiappa_rhino and colt_python) were named the same,
  name the python to indicate it looks like a old west revolver
- Name the BLR magazine with a common identifier to the the gun
- Give the FN57 an identifier (FN)
- Add pistol to BAD_IDENTIFIERS, so the USP identifier is detected

Both the FN57 and USP pistol were using "pistol" as the identifier.
The BLR was using "ing".

Author: anothersimulacrum

data/json/items/gun/3006.json

@@ -4,7 +4,7 @@
     "looks_like": "modular_ar15",
     "type": "GUN",
     "reload_noise_volume": 10,
-    "name": { "str": "magazine-fed lever-action hunting rifle" },
+    "name": { "str": "BLR lever-action hunting rifle" },
     "description": "A highly accurate lever-action hunting rifle chambered for the powerful .30-06 round.  Notable for using a detachable magazine instead of a traditional tube.",
     "variant_type": "gun",
     "variants": [

data/json/items/gun/38.json

@@ -157,7 +157,7 @@
     "copy-from": "pistol_revolver",
     "looks_like": "sw_619",
     "type": "GUN",
-    "name": { "str_sp": ".357 revolver" },
+    "name": { "str_sp": "classic .357 revolver", "//": "This looks like a classic revolver, from a western" },
     "//": "This is the Colt Python 2020 6-inch version.",
     "description": "A six inch revolver chambered in .357 Magnum/.38 Special.  Favorite of sheriffs and post-Cataclysm survivor group leaders.",
     "//s": "omg twd reference :O",
@@ -401,7 +401,7 @@
     "copy-from": "rifle_manual",
     "looks_like": "modular_ar15",
     "type": "GUN",
-    "name": { "str": ".357 lever-action rifle" },
+    "name": { "str": "long-barreled .357 lever-action rifle" },
     "description": "This lever-action rifle is chambered in the powerful .357 Magnum cartridge, with an 20\" barrel with a tube-fed magazine.  Go get 'em cowboy!",
     "variant_type": "gun",
     "variants": [

data/json/items/gun/44.json

@@ -319,7 +319,7 @@
     "copy-from": "rifle_manual",
     "looks_like": "modular_ar15",
     "type": "GUN",
-    "name": { "str": ".44 lever-action rifle" },
+    "name": { "str": "long-barreled .44 lever-action rifle" },
     "description": "This lever-action rifle is chambered in the powerful .44 Magnum cartridge, with an 20\" barrel with a tube-fed magazine.  Go get 'em cowboy!",
     "variant_type": "gun",
     "variants": [

data/json/items/gun/57.json

@@ -4,7 +4,7 @@
     "looks_like": "glock_17",
     "type": "GUN",
     "reload_noise_volume": 10,
-    "name": { "str": "5.7mm pistol" },
+    "name": { "str": "FN 5.7mm pistol" },
     "description": "Firing the armor-piercing 5.7x28mm round, this lightweight handgun was developed for NATO use as a sidearm capable of penetrating body armor.  Its proprietary and nonprolific ammunition kept it comparatively rare among both civilian and militant use, but the gun's ability to ignore most forms of conventional ballistic armor can't be argued with.  Given that its tiny bullets have next to no stopping power, its armor-penetrating capability comes at a considerable trade-off.",
     "variant_type": "gun",
     "variants": [

data/json/items/magazine/57.json

@@ -3,7 +3,7 @@
     "id": "fn57mag",
     "looks_like": "glock17_17",
     "type": "MAGAZINE",
-    "name": { "str": "5.7mm 20-round pistol magazine" },
+    "name": { "str": "FN 5.7mm 20-round pistol magazine" },
     "description": "A 20-round box magazine, for use with handguns chambering the proprietary 5.7x28mm cartridge.",
     "variant_type": "gun",
     "variants": [

tools/json_tools/gun_variant_validator.py

@@ -141,6 +141,7 @@
     "plasma_gun",
     "bbgun",
 }
+# Stripped from gun/mag names before checking for an identifier
 BAD_IDENTIFIERS = [
     "10mm",
     ".22",
@@ -157,9 +158,25 @@
     "9x19mm",
     "-round",
     "magazine",
+    "pistol",
     "stripper",
     "speedloader",
 ]
+# Common tokens that will be rejected
+BAD_COMMON_TOKENS = {
+    "rifle",
+    "carbine",
+    "pistol",
+    "ing"
+}
+# Common tokens that are permitted to be below length reqs
+SHORT_COMMON_TOKENS = {
+    "AI",  # Abbreviation of gun manufacturer
+    "AK",  # Common name for a gun family
+    "FN",  # Common name for a manufacturer
+    "G3",  # Common name for a certain gun
+    "M9",  # Common name for a certain gun
+}
 TYPE_DESCRIPTORS = [
     "automagnum",
     "blunderbuss",
@@ -195,6 +212,10 @@
     "submachine gun",
     "trenchgun",
 ]
+DUPE_CHECK_BLACKLIST = [
+    # No magazines, and very similar tube-fed rifles with slightly diff barrels
+    {"rio_bravo", "henry_golden_boy"},
+]
 
 """
 JSON parsing functions
@@ -591,11 +612,12 @@ def common_token(names):
     # Assume the longest common substring will be the "identifier"
     # leading/trailing whitespace isn't meaningful in identifiers
     common_token = longest_common_substring(names).strip()
-    # It can't be a meaningful identifier if it's 1 character long
-    if len(common_token) < 2:
+    # It can't be a meaningful identifier if it's 1-2 characters long
+    # Some exceptions (e.g. AK, G3)
+    if len(common_token) < 3 and common_token not in SHORT_COMMON_TOKENS:
         return None
     # Some common identifiers that don't work
-    if common_token in {"11", "to", "if", "ip", "rifle", "carbine"}:
+    if common_token in BAD_COMMON_TOKENS:
         return None
     return common_token
 
@@ -682,7 +704,24 @@ def find_bad_names(all_guns):
 """
 
 
+def remove_blacklisted_dupes(guns):
+    if len(guns) == 1:
+        return guns
+    guns_set = set(map(lambda gun: gun["id"], guns))
+    for blacklist_set in DUPE_CHECK_BLACKLIST:
+        all_match = True
+        for gun in blacklist_set:
+            if gun not in guns_set:
+                print(gun, "not in", guns_set)
+                all_match = False
+                break
+        if all_match:
+            guns = list(filter(lambda g: g["id"] not in blacklist_set, guns))
+    return guns
+
+
 def find_dupe_names(all_guns):
+    error = False
     all_names = {}
     for gun in all_guns:
         name = name_of(gun) + str(sorted(gun["ammo"]))
@@ -691,12 +730,15 @@ def find_dupe_names(all_guns):
         else:
             all_names[name] = [gun]
     for key, value in all_names.items():
-        if len(value) == 1:
+        value = remove_blacklisted_dupes(value)
+        if len(value) < 2:
             continue
         out = "ERROR: Guns have the same name and ammo (" + key + "):"
+        error = True
         for gun in value:
             out += " (" + gun["id"] + "),"
         print(out)
+    return error
 
 
 """
@@ -781,9 +823,9 @@ def check_names(all_guns):
     for bad in bad_names:
         print("ERROR: Gun %s (%s) lacks a descriptive name" % (bad[1], bad[0]))
 
-    find_dupe_names(all_guns)
+    dupes = find_dupe_names(all_guns)
 
-    return len(bad_names) > 0
+    return len(bad_names) > 0 or dupes
 
 
 csv = True