refactor tests/test_regex_identifier.py

[jyooru]

⚠ Pull Requests not made with this template will be automatically closed 🔥

Prerequisites

• Have you read the documentation on contributing? https://github.com/bee-san/pyWhat/wiki/Adding-your-own-Regex

Why do we need this pull request?

Currently, the tests files are quite long. I've attempted moving the test data into regex.json and using pytest.mark.parmaterize to "generate" tests using the test data now in regex.json. This makes it much easier to maintain test_regex_identifier.py as to change all _assert_match_first_item tests, you only have to change one test:

@pytest.mark.parametrize(
    "name,match",
    [
        (regex["Name"], match)
        for regex in database
        for match in regex.get("Matches", [])
    ],
)
def test_regex_match(name: str, match: str):
    res = r.check([match])
    _assert_match_first_item(name, res)

What GitHub issues does this fix?

Related to #199
Related to #195

Contributions to this PR are welcome!

[codecov-commenter]

Codecov Report

Merging #202 (c7970e4) into main (2589780) will decrease coverage by 2.18%.
The diff coverage is 83.33%.

@@            Coverage Diff             @@
##             main     #202      +/-   ##
==========================================
- Coverage   94.50%   92.32%   -2.19%     
==========================================
  Files          14       14              
  Lines        1729     1198     -531     
==========================================
- Hits         1634     1106     -528     
+ Misses         95       92       -3     

Impacted Files	Coverage Δ
tests/test_regex_database.py	87.50% <55.55%> (ø)
tests/test_regex_identifier.py	96.77% <95.23%> (-1.81%)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2589780...c7970e4. Read the comment docs.

[ghost]

Can you change "Matches" to "Examples"?

[jyooru]

Can you change "Matches" to "Examples"?

Yeah, I'm planing on also adding some strings that should not be matched. Does something like this sound alright?

{
  "Name": "Email Address",
  ...
  "Examples": {
    "Valid": ["firstname+lastname@example.com"],
    "Invalid": ["email@example@example.com"]
  }
}

def test_email4():
    res = r.check(["email@example@example.com"])
    assert "Email Address" not in res

[ghost]

Can you change "Matches" to "Examples"?

Yeah, I'm planing on also adding some strings that should not be matched. Does something like this sound alright?

{

  "Name": "Email Address",

  ...

  "Examples": {

    "Valid": ["firstname+lastname@example.com"],

    "Invalid": ["email@example@example.com"]

  }

}

def test_email4():

    res = r.check(["email@example@example.com"])

    assert "Email Address" not in res

Amazing

[bee-san]

This is great!! Makes it way easier for people to test their code, and it allows people in the future to see examples of things :D

happy to merge this, 1 question -- why is code coverage down? 🤔 other than that, it looks good to me :D !!! 🥳

[jyooru]

This is great!! Makes it way easier for people to test their code, and it allows people in the future to see examples of things :D

happy to merge this, 1 question -- why is code coverage down? thinking other than that, it looks good to me :D !!! partying_face

Thanks!

Code coverage is down due to amount of lines of code removed, as pytest is practically just rerunning the function for each match. JSON does not contribute to coverage either. I will be checking that there is the same amount of test cases before and after, that way I know I haven't left anything out accidentally.

[jyooru]

Please squash!

[bee-san]

Can you change the codecov stuff slightly so it passes CI? :)