Add depid unit tests

tests/test_depid.py

@@ -0,0 +1,221 @@
+from unittest.mock import Mock, MagicMock
+
+import pytest
+import spacy
+
+from pycpidr.depid import (EXCLUDED_DETERMINERS, EXCLUDED_NSUBJ, depid, is_excluded_determiner, is_excluded_nsubj,
+                           is_i_you_subject)
+
+
+try:
+    nlp = spacy.load("en_core_web_sm")
+except OSError:
+    raise OSError(
+        "The 'en_core_web_sm' model is not installed. Please install it using: `python -m spacy download en_core_web_sm`."
+    )
+
+def test_depid_basic():
+    text = "The cat sat on the mat."
+    density, word_count, dependencies = depid(text)
+    assert isinstance(density, float)
+    assert word_count == 6
+    assert len(dependencies) > 0
+
+def test_depid_empty_text():
+    text = ""
+    density, word_count, dependencies = depid(text)
+    assert density == 0.0
+    assert word_count == 0
+    assert len(dependencies) == 0
+
+def test_depid_punctuation_and_spaces():
+    text = "Hello,   world!   How are you?"
+    density, word_count, dependencies = depid(text)
+    assert word_count == 5
+
+def test_depid_sentence_filter():
+    text = "I am happy. The sun is shining."
+    density, word_count, dependencies = depid(text, sentence_filters=[is_i_you_subject])
+    assert "I" not in [dep[0] for dep in dependencies]
+
+def test_depid_token_filter():
+    text = "The cat and the dog are playing."
+    density, word_count, dependencies = depid(text, token_filters=[is_excluded_determiner])
+    assert "the" not in [dep[0] for dep in dependencies]
+
+def test_depid_custom_filters():
+    def custom_sentence_filter(sent):
+        return len(sent) > 3
+
+    def custom_token_filter(token):
+        return token.pos_ != "VERB"
+
+    text = "I run. The quick brown fox jumps over the lazy dog."
+    density, word_count, dependencies = depid(text, 
+                                              sentence_filters=[custom_sentence_filter],
+                                              token_filters=[custom_token_filter])
+    assert len(dependencies) > 0
+    assert "run" not in [dep[0] for dep in dependencies]
+    assert "jumps" not in [dep[0] for dep in dependencies]
+
+def test_depid_dependency_types():
+    text = "The big brown dog quickly chased the small cat."
+    density, word_count, dependencies = depid(text)
+    dep_types = set(dep[1] for dep in dependencies)
+    assert dep_types.issubset(set(["amod", "nsubj", "advmod", "dobj"]))
+
+def test_depid_density_calculation():
+    text = "The cat sat. The dog ran."
+    density, word_count, dependencies = depid(text)
+    expected_density = len(dependencies) / word_count
+    assert abs(density - expected_density) < 1e-6
+
+def test_depid_word_count_accuracy():
+    text = "This is a test sentence with ten words in it."
+    density, word_count, dependencies = depid(text)
+    assert word_count == 10
+
+
+@pytest.fixture
+def mock_span():
+    mock_span = MagicMock(spec=spacy.tokens.Span)
+    return mock_span
+
+@pytest.fixture
+def mock_token():
+    mock_token = Mock()
+    return mock_token
+
+
+def test_is_i_you_subject_with_i_subject(mock_span, mock_token):
+    mock_token.text = "I"
+    mock_token.dep_ = "nsubj"
+    mock_token.head.dep_ = "ROOT"
+
+    mock_span.__iter__.return_value = [mock_token]
+
+    result = is_i_you_subject(mock_span)
+
+    assert result == False
+
+def test_is_i_you_subject_with_you_subject(mock_token, mock_span):
+    mock_token.text = "You"
+    mock_token.dep_ = "nsubj"
+    mock_token.head.dep_ = "ROOT"
+
+    mock_span.__iter__.return_value = [mock_token]
+
+    result = is_i_you_subject(mock_span)
+
+    assert result == False
+
+def test_is_i_you_subject_with_other_subject(mock_token, mock_span):
+    mock_token.text = "He"
+    mock_token.dep_ = "nsubj"
+    mock_token.head.dep_ = "ROOT"
+    mock_span.__iter__.return_value = [mock_token]
+
+    result = is_i_you_subject(mock_span)
+
+    assert result == True
+
+def test_is_i_you_subject_with_i_not_subject(mock_token, mock_span):
+    mock_token.text = "I"
+    mock_token.dep_ = "dobj"
+    mock_token.head.dep_ = "ROOT"
+    mock_span.__iter__.return_value = [mock_token]
+
+    result = is_i_you_subject(mock_span)
+
+    assert result == True
+
+def test_is_i_you_subject_with_i_not_root_verb(mock_token, mock_span):
+    mock_token.text = "I"
+    mock_token.dep_ = "nsubj"
+    mock_token.head.dep_ = "conj"
+    mock_span.__iter__.return_value = [mock_token]
+
+    result = is_i_you_subject(mock_span)
+
+    assert result == True
+
+
+def test_is_excluded_determiner_with_excluded_determiner(mock_token):
+    mock_token.dep_ = "det"
+    mock_token.text = "the"
+
+    result = is_excluded_determiner(mock_token)
+
+    assert result == False
+
+def test_is_excluded_determiner_with_non_excluded_determiner(mock_token):
+    mock_token.dep_ = "det"
+    mock_token.text = "this"
+
+    result = is_excluded_determiner(mock_token)
+
+    assert result == True
+
+def test_is_excluded_determiner_with_non_determiner(mock_token):
+    mock_token.dep_ = "nsubj"
+    mock_token.text = "the"
+
+    result = is_excluded_determiner(mock_token)
+
+    assert result == True
+
+def test_is_excluded_determiner_case_insensitive(mock_token):
+    mock_token.dep_ = "det"
+    mock_token.text = "The"
+
+    result = is_excluded_determiner(mock_token)
+
+    assert result == False
+
+def test_is_excluded_determiner_with_all_excluded_determiners(mock_token):
+    mock_token.dep_ = "det"
+
+    for determiner in EXCLUDED_DETERMINERS:
+        mock_token.text = determiner
+        result = is_excluded_determiner(mock_token)
+        assert result == False
+
+def test_is_excluded_nsubj_with_excluded_subject(mock_token):
+    mock_token.dep_ = "nsubj"
+    mock_token.text = "it"
+
+    result = is_excluded_nsubj(mock_token)
+
+    assert result == False
+
+def test_is_excluded_nsubj_with_non_excluded_subject(mock_token):
+    mock_token.dep_ = "nsubj"
+    mock_token.text = "he"
+
+    result = is_excluded_nsubj(mock_token)
+
+    assert result == True
+
+def test_is_excluded_nsubj_with_non_nsubj(mock_token):
+    mock_token.dep_ = "dobj"
+    mock_token.text = "it"
+
+    result = is_excluded_nsubj(mock_token)
+
+    assert result == True
+
+def test_is_excluded_nsubj_case_insensitive(mock_token):
+    mock_token.dep_ = "nsubj"
+    mock_token.text = "It"
+
+    result = is_excluded_nsubj(mock_token)
+
+    assert result == False
+
+def test_is_excluded_nsubj_with_all_excluded_subjects(mock_token):
+    mock_token.dep_ = "nsubj"
+
+    for subject in EXCLUDED_NSUBJ:
+        mock_token.text = subject
+        result = is_excluded_nsubj(mock_token)
+        assert result == False