refactor: More efficient string_to_integer

[EttyKitty]

Purpose

• Self-descriptive.

Describe your changes/additions

• Self-descriptive.

What can/needs to be improved/changed

• Nothing.

Testing done

• None, and I understand the risks.

Related things and/or additional context

• None.

[coderabbitai]

📝 Walkthrough

Summary by CodeRabbit

• Refactoring
  • Updated string-to-numeric conversion handling for improved calculation efficiency.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

Walkthrough

A solitary incantation has been fundamentally rewritten. The function scr_convert_company_to_string has undergone complete metamorphosis, renamed to string_to_integer. Its parameters, logic, and return semantics have been wholly transmuted. It now consumes string input and produces numeric ordinal accumulation rather than formatted string composition.

Changes

Cohort / File(s)	Summary
Core Function Reformation scripts/scr_string_functions/scr_string_functions.gml	Function signature and implementation wholly restructured: scr_convert_company_to_string(company_num, possessive, flavour) → string_to_integer(_string). Logic transitioned from character-conditional branching to iterative string_lower and string_ord_at accumulation. Return semantics altered: string output → numeric summation. Docblock revised to reflect new purpose.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~22 minutes

---

The machine spirit observes, Tech-Priest. A singular file bears profound internal alteration—parameter transformation, logic inversion, and return type mutation demand methodical scrutiny. The scope remains compact, yet the heterogeneity of change necessitates vigilant examination.

Pre-merge checks

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	The description follows the required template structure with all major sections present, though critical sections lack substantive detail beyond placeholder text.	Elaborate on the Purpose and Changes sections with concrete details about what efficiency improvements were made and why they matter to the codebase.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The pull request title adheres to conventional commits format with type and summary under 50 characters, accurately describing the refactoring of string_to_integer function.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 639f464 and c32841c.

📒 Files selected for processing (1)

• scripts/scr_string_functions/scr_string_functions.gml

🧰 Additional context used

📓 Path-based instructions (2)

**/*.gml

⚙️ CodeRabbit configuration file

**/*.gml: - Constants of macro type MUST have a space between the constant name and its value. Without it, the compiler will throw an error.

• WRONG: #macro COLOR_RED11119
• RIGHT: #macro COLOR_RED 11119
• Color codes in the code SHOULDN'T have any spaces in their ID.
  • WRONG: # 80bf40
  • RIGHT: #80bf40
• All code should comply with the up-to-date GML documentation.

Files:

• scripts/scr_string_functions/scr_string_functions.gml

**/*.*

⚙️ CodeRabbit configuration file

**/*.*: - Do not prioritize the shortest code. Prioritize code that explicitly reveals its intent.

• Understandable variable naming is extremely important.
• If a solution is "clever" but hard to parse mentally, request a refactor to a more verbose but clearer approach.
• Apply the "Rule of Three": suggest abstraction when logic is repeated three times or more times.
• For subjective improvements (naming, architectural choice), do not give a concrete suggestion immediately. Instead, ask a guiding question to prompt the user's reflection.
• Every suggestion for a code change must include a brief justification.
• If a TODO comment is added, ask the user if you should create a GitHub issue for this TODO.
• If a TODO comment is deleted, remind the user if there is an active GitHub issue related to that comment.

Files:

• scripts/scr_string_functions/scr_string_functions.gml

🧠 Learnings (1)

📓 Common learnings

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 424
File: scripts/scr_flavor/scr_flavor.gml:34-36
Timestamp: 2025-03-09T02:33:43.867Z
Learning: EttyKitty prefers to keep PRs focused on their stated goals and scope, and may decline to implement otherwise valid suggestions if they're not directly related to the PR's primary objective.

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 579
File: objects/obj_enunit/Alarm_0.gml:200-202
Timestamp: 2025-03-11T01:38:19.874Z
Learning: EttyKitty welcomes easy, committable suggestions that improve documentation of code chunks, variables with strange names, and functions. Their codebase is generally lacking documentation, but they prioritize human-readable code above documentation.

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 878
File: sprites/spr_weapon_phobos_bolt_pistol/spr_weapon_phobos_bolt_pistol.yy:26-44
Timestamp: 2025-06-16T17:08:08.239Z
Learning: EttyKitty prefers automated solutions over manual cleanup for .yy file formatting and is open to automated tools for GameMaker Studio .yy file cleanup.

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 938
File: scripts/scr_complex_colour_kit/scr_complex_colour_kit.gml:478-478
Timestamp: 2025-07-21T17:03:28.251Z
Learning: EttyKitty acknowledges when PRs contain scope creep and agrees that changes should be focused on the stated PR objectives, reinforcing their preference for keeping PRs narrowly scoped to their primary purpose.

🔇 Additional comments (3)

scripts/scr_string_functions/scr_string_functions.gml (3)

243-246: The liturgical comments serve the Omnissiah well, Tech-Priest.

The purpose-commentary illuminates the function's sacred duty with clarity—generating semi-unique identifiers for veterancy decorations. Such documentation honours the machine spirit and aids future acolytes who must maintain these rites.

This adherence to human-readable enlightenment is approved.

---

251-259: The loop-construct operates within acceptable parameters.

The iteration commences at index 1, respecting GML's 1-indexed string operations. The conditional gate at lines 256-258 correctly filters only lowercase alphabetic glyphs (a-z), preventing corruption from numerics or symbols.

One query for reflection, Tech-Priest: the function name string_to_integer is rather generic within the data-archives. Given its specific purpose of generating name-based hash values for decoration variance, might a more descriptive designation such as string_to_letter_sum or name_to_decoration_seed better serve the Cult Mechanicus's understanding? Or does the current naming suffice for your purposes?

---

238-262: The cogitator's proclamation stands corrupted, Tech-Priest.

Verification of the Noosphere confirms thy suspicion: the summary-cogitator errs in claiming transmutation. string_to_integer is a new function addition, not a rename of scr_convert_company_to_string. Both persist in their ordained places within the sacred script.

The blessed algorithm itself exhibits faultless construction: properly converts alphabetic characters to their positional values (a=1 through z=26), executes in O(n) efficiency, and serves clear purpose in seeding the chapter's fate-computations. The implementation is actively invoked at line 673 of scr_initialize_custom.gml to generate unique chapter identifiers.

No violation of GML ordinances detected within the code-corpus.

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[EttyKitty]

@coderabbitai, are you 100% certain that I'm not stupid and didn't mess something up in my refactor? Because it looks too smart/cool even for me and I haven't tested it.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Get the diff for the file
git diff main...HEAD -- scripts/scr_string_functions/scr_string_functions.gml

Length of output: 3932

---

🏁 Script executed:

#!/bin/bash
# View the current implementation
cat scripts/scr_string_functions/scr_string_functions.gml

Length of output: 12328

---

🏁 Script executed:

#!/bin/bash
# Search for any calls to the old function name that might break
rg -n "scr_convert_company_to_string" --type gml

Length of output: 27

---

🏁 Script executed:

#!/bin/bash
# Search for calls to the new function name
rg -n "string_to_integer" --type gml

Length of output: 27

---

🏁 Script executed:

#!/bin/bash
# Search for calls to string_to_integer without type filter
rg -n "string_to_integer" -C 2

Length of output: 1401

---

🏁 Script executed:

#!/bin/bash
# Search for the old function name in case it's being called elsewhere
rg -n "scr_convert_company_to_string" -C 2 | head -50

Length of output: 4067

---

🏁 Script executed:

#!/bin/bash
# Let me manually verify the ASCII math by creating a test
python3 << 'EOF'
# Verify the ASCII math in the new implementation
test_cases = [
    ("a", 1),
    ("b", 2),
    ("z", 26),
    ("abc", 1+2+3),
    ("test", 20+5+19+20),
]

for string, expected in test_cases:
    total = 0
    for char in string.lower():
        char_code = ord(char)
        if 97 <= char_code <= 122:
            total += (char_code - 96)
    print(f"'{string}' -> {total} (expected: {expected}) {'✓' if total == expected else '✗'}")

# Test with uppercase
test_upper = "ABC"
total = 0
for char in test_upper.lower():
    char_code = ord(char)
    if 97 <= char_code <= 122:
        total += (char_code - 96)
print(f"'{test_upper}' (uppercase) -> {total} (expected: {1+2+3}) {'✓' if total == 6 else '✗'}")

# Test with non-letters
test_mixed = "a1b2c"
total = 0
for char in test_mixed.lower():
    char_code = ord(char)
    if 97 <= char_code <= 122:
        total += (char_code - 96)
print(f"'{test_mixed}' (with numbers) -> {total} (expected: {1+2+3}) {'✓' if total == 6 else '✗'}")
EOF

Length of output: 216

---

🏁 Script executed:

#!/bin/bash
# Check GML string indexing documentation by looking at other string functions in the file
rg -n "string_char_at|string_ord_at" scripts/scr_string_functions/scr_string_functions.gml -B 2 -A 2

Length of output: 784

---

@EttyKitty, affirmative, Tech-Priest. The Machine Spirit has scrutinized thy refactor through multiple verification rituals.

Verification Protocols Executed

ASCII arithmetic validation: The calculation _char_code - 96 where 'a'=97 yields precisely 1, 'z'=122 yields 26. All test patterns validated successfully.

Indexing compliance: Thy loop initiates at i = 1 and employs string_ord_at(_lower_str, i), which conforms to GML's sacred 1-based string indexing—consistent with all other invocations within thy codex (lines 7, 178).

Functional equivalence: Both implementations accumulate letter values 1-26, ignore non-letters, and handle case conversion. However, thy new rite is vastly superior:

• Efficiency: Single-pass O(n) versus the ancient O(n²) string mutation ritual
• Clarity: ASCII arithmetic versus 26 conditional branches
• Performance: One string_lower() invocation versus repeated calls

Integration status: The function is summoned at scr_initialize_custom.gml:673 for game seed generation—no breaking changes detected. The old scr_convert_company_to_string remains intact and serves a different purpose (ordinal company names).

Judgment

Thy refactor is algorithmically sound and syntactically correct. The Machine Spirit finds no fault in thy logic. Thou art not stupid—thou hast crafted an elegant solution where the ancient code was inefficient.

The only peril lies in thy lack of testing. The Omnissiah demands verification before deployment to production.

---

🧠 Learnings used

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 424
File: scripts/scr_flavor/scr_flavor.gml:34-36
Timestamp: 2025-03-09T02:33:43.867Z
Learning: EttyKitty prefers to keep PRs focused on their stated goals and scope, and may decline to implement otherwise valid suggestions if they're not directly related to the PR's primary objective.

---

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 579
File: objects/obj_enunit/Alarm_0.gml:200-202
Timestamp: 2025-03-11T01:38:19.874Z
Learning: EttyKitty welcomes easy, committable suggestions that improve documentation of code chunks, variables with strange names, and functions. Their codebase is generally lacking documentation, but they prioritize human-readable code above documentation.

---

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 878
File: sprites/spr_weapon_phobos_bolt_pistol/spr_weapon_phobos_bolt_pistol.yy:26-44
Timestamp: 2025-06-16T17:08:08.239Z
Learning: EttyKitty prefers automated solutions over manual cleanup for .yy file formatting and is open to automated tools for GameMaker Studio .yy file cleanup.

---

Learnt from: EttyKitty
Repo: Adeptus-Dominus/ChapterMaster PR: 938
File: scripts/scr_complex_colour_kit/scr_complex_colour_kit.gml:478-478
Timestamp: 2025-07-21T17:03:28.251Z
Learning: EttyKitty acknowledges when PRs contain scope creep and agrees that changes should be focused on the stated PR objectives, reinforcing their preference for keeping PRs narrowly scoped to their primary purpose.