Dev (#36)

### Dependency Changes

+ Update dependency on spaCy to 3.7.0

Author: tanloong

CHANGELOG.md

@@ -1,5 +1,11 @@
 <div align="center"><h1>Changelog</h1></div>
 
+## [0.0.54](https://github.com/tanloong/neosca/releases/tag/0.0.54) (2 October 2023)
+
+### Dependency Changes
+
++ Update dependency on spaCy to 3.7.0
+
 ## [0.0.53](https://github.com/tanloong/neosca/releases/tag/0.0.53) (25 September 2023)
 
 ### Improvements

README.md

@@ -461,7 +461,7 @@ BibTeX
 
 ```BibTeX
 @misc{tan2022neosca,
-title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.0.53},
+title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.0.54},
 author       = {Long Tan},
 howpublished = {\url{https://github.com/tanloong/neosca}},
 year         = {2022}
@@ -476,7 +476,7 @@ year         = {2022}
 APA (7th edition)
 </summary>
 
-<pre>Tan, L. (2022). <i>NeoSCA</i> (version 0.0.53) [Computer software]. Github. https://github.com/tanloong/neosca</pre>
+<pre>Tan, L. (2022). <i>NeoSCA</i> (version 0.0.54) [Computer software]. Github. https://github.com/tanloong/neosca</pre>
 
 </details>
 
@@ -486,7 +486,7 @@ APA (7th edition)
 MLA (9th edition)
 </summary>
 
-<pre>Tan, Long. <i>NeoSCA</i>. version 0.0.53, GitHub, 2022, https://github.com/tanloong/neosca.</pre>
+<pre>Tan, Long. <i>NeoSCA</i>. version 0.0.54, GitHub, 2022, https://github.com/tanloong/neosca.</pre>
 
 </details>
 

README_zh_cn.md

@@ -451,7 +451,7 @@ BibTeX
 
 ```BibTeX
 @misc{tan2022neosca,
-title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.0.53},
+title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.0.54},
 author       = {Long Tan},
 howpublished = {\url{https://github.com/tanloong/neosca}},
 year         = {2022}
@@ -466,7 +466,7 @@ year         = {2022}
 APA (7th edition)
 </summary>
 
-<pre>Tan, L. (2022). <i>NeoSCA</i> (version 0.0.53) [Computer software]. Github. https://github.com/tanloong/neosca</pre>
+<pre>Tan, L. (2022). <i>NeoSCA</i> (version 0.0.54) [Computer software]. Github. https://github.com/tanloong/neosca</pre>
 
 </details>
 
@@ -476,7 +476,7 @@ APA (7th edition)
 MLA (9th edition)
 </summary>
 
-<pre>Tan, Long. <i>NeoSCA</i>. version 0.0.53, GitHub, 2022, https://github.com/tanloong/neosca.</pre>
+<pre>Tan, Long. <i>NeoSCA</i>. version 0.0.54, GitHub, 2022, https://github.com/tanloong/neosca.</pre>
 
 </details>
 

README_zh_tw.md

@@ -451,7 +451,7 @@ BibTeX
 
 ```BibTeX
 @misc{tan2022neosca,
-title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.0.53},
+title        = {NeoSCA: A Fork of L2 Syntactic Complexity Analyzer, version 0.0.54},
 author       = {Long Tan},
 howpublished = {\url{https://github.com/tanloong/neosca}},
 year         = {2022}
@@ -466,7 +466,7 @@ year         = {2022}
 APA (7th edition)
 </summary>
 
-<pre>Tan, L. (2022). <i>NeoSCA</i> (version 0.0.53) [Computer software]. Github. https://github.com/tanloong/neosca</pre>
+<pre>Tan, L. (2022). <i>NeoSCA</i> (version 0.0.54) [Computer software]. Github. https://github.com/tanloong/neosca</pre>
 
 </details>
 
@@ -476,7 +476,7 @@ APA (7th edition)
 MLA (9th edition)
 </summary>
 
-<pre>Tan, Long. <i>NeoSCA</i>. version 0.0.53, GitHub, 2022, https://github.com/tanloong/neosca.</pre>
+<pre>Tan, Long. <i>NeoSCA</i>. version 0.0.54, GitHub, 2022, https://github.com/tanloong/neosca.</pre>
 
 </details>
 

neosca/about.py

@@ -1,4 +1,4 @@
 #!/usr/bin/env python3
 # -*- coding=utf-8 -*-
 
-__version__ = "0.0.53"
+__version__ = "0.0.54"

neosca/depends_installer.py

@@ -17,11 +17,11 @@
 import urllib.request
 import zipfile
 
-from .scaplatform import IS_DARWIN, IS_WINDOWS, USER_SOFTWARE_DIR
+from .scaplatform import IS_MAC, IS_WINDOWS, USER_SOFTWARE_DIR
 from .scaprint import get_yes_or_no, same_line_print
 from .util import SCAProcedureResult
 
-if IS_DARWIN:
+if IS_MAC:
     import ssl
 
     try:
@@ -34,7 +34,7 @@
 _UNPACK200 = "unpack200.exe" if IS_WINDOWS else "unpack200"
 _UNPACK200_ARGS = '-r -v -l ""' if IS_WINDOWS else ""
 
-OS = "windows" if IS_WINDOWS else "mac" if IS_DARWIN else platform
+OS = "windows" if IS_WINDOWS else "mac" if IS_MAC else platform
 ARCH = "x64" if maxsize > 2**32 else "x32"
 
 _TAR = ".tar"

neosca/lca/main.py

@@ -151,7 +151,7 @@ def install_model(self) -> SCAProcedureResult:
                 "-m",
                 "pip",
                 "install",
-                "https://master.dl.sourceforge.net/project/en-core-web-sm/en_core_web_sm-3.6.0-py3-none-any.whl?viasf=1",
+                "https://master.dl.sourceforge.net/project/en-core-web-sm/en_core_web_sm-3.7.0-py3-none-any.whl?viasf=1",
             ]
         else:
             command = [sys.executable, "-m", "spacy", "download", "en_core_web_sm"]
@@ -164,44 +164,83 @@ def install_model(self) -> SCAProcedureResult:
         return True, None
 
     def check_spacy_and_model(self) -> SCAProcedureResult:
+        required_version_prefix = "3.7."
+        required_version_range = ">=3.7.0,<3.8.0"
+        ask_install_spacy = False
+        ask_install_model = False
+
         try:
             logging.info("Trying to load spaCy...")
             import spacy  # type: ignore # noqa: F401 'spacy' imported but unused
+
         except ModuleNotFoundError:
-            is_install = get_yes_or_no(
-                "Running LCA requires spaCy. Do you want me to install it for you?"
-            )
-            if not is_install:
-                return (
-                    False,
-                    (
-                        "\nspaCy installation is refused. You need to manually install it using:"
-                        "\npip install spacy"
-                    ),
-                )
-            return self.install_spacy()
+            ask_install_spacy = True
         else:
-            color_print("OKGREEN", "ok", prefix="spaCy has already been installed. ")
+            spacy_version = spacy.__version__
+            if not spacy_version.startswith(required_version_prefix):
+                logging.info(
+                    f"The installed version {spacy_version} of spaCy does not match the version"
+                    f" required by NeoSCA: {required_version_range}"
+                )
+                ask_install_spacy = True
+            else:
+                color_print(
+                    "OKGREEN",
+                    "ok",
+                    prefix=f"spaCy{required_version_range} has already been installed. ",
+                )
 
         try:
             logging.info("Trying to load en_core_web_sm...")
             import en_core_web_sm  # type: ignore # noqa: F401 'en_core_web_sm' imported but unused
         except ModuleNotFoundError:
+            ask_install_model = True
+        else:
+            model_version = en_core_web_sm.__version__
+            if not model_version.startswith(required_version_prefix):
+                logging.info(
+                    f"The installed version {model_version} of en_core_web_sm does not match the"
+                    f" version required by NeoSCA: {required_version_range}"
+                )
+                ask_install_model = True
+            else:
+                color_print(
+                    "OKGREEN",
+                    "ok",
+                    prefix=(
+                        f"en_core_web_sm{required_version_range} has already been installed. "
+                    ),
+                )
+
+        if ask_install_spacy:
+            is_install = get_yes_or_no(
+                f"\nRunning LCA requires spaCy{required_version_range}, do you want me to"
+                " install/update it for you?"
+            )
+            if is_install:
+                return self.install_spacy()
+            else:
+                return (
+                    False,
+                    "\nYou need to manually install it using:\npip install -U spacy",
+                )
+        if ask_install_model:
             is_install = get_yes_or_no(
-                "Running LCA requires spaCy's en_core_web_sm model. Do you want me to install it for you?"
+                f"\nRunning LCA requires spaCy's model en_core_web_sm{required_version_range},"
+                " do you want me to install it for you?"
             )
-            if not is_install:
+            if is_install:
+                return self.install_model()
+            else:
                 return (
                     False,
                     (
-                        "\nen_core_web_sm installation is refused. You need to manually install it using:"
+                        "\nYou need to manually install it using:"
                         "\npython -m spacy download en_core_web_sm"
                     ),
                 )
-            return self.install_model()
-        else:
-            color_print("OKGREEN", "ok", prefix="en_core_web_sm has already been installed. ")
-            return True, None
+
+        return True, None
 
     def exit_routine(self) -> None:
         if self.options.is_quiet or self.options.is_stdout:

neosca/scaenv.py

@@ -7,7 +7,7 @@
 import os.path as os_path
 from typing import List, Optional
 
-from .scaplatform import IS_DARWIN, IS_LINUX, IS_WINDOWS
+from .scaplatform import IS_MAC, IS_LINUX, IS_WINDOWS
 from .scaprint import color_print
 
 JAVA_HOME = "JAVA_HOME"
@@ -58,7 +58,7 @@ def _setenv_unix(env_var: str, paths: List[str], is_refresh: bool = False) -> No
         )
     else:
         shell_rcfile = {
-            "bash": "~/.bash_profile" if IS_DARWIN else "~/.bashrc",
+            "bash": "~/.bash_profile" if IS_MAC else "~/.bashrc",
             "zsh": "~/.zshrc",
             "ksh": "~/.kshrc",
             "tcsh": "~/.tcshrc",
@@ -107,7 +107,7 @@ def _setenv_unix(env_var: str, paths: List[str], is_refresh: bool = False) -> No
 def setenv(
     env_var: str, paths: List[str], is_override: bool = False, is_quiet: bool = False
 ) -> None:
-    assert any((IS_WINDOWS, IS_DARWIN, IS_LINUX))
+    assert any((IS_WINDOWS, IS_MAC, IS_LINUX))
     if IS_WINDOWS:
         _setenv_windows(env_var, paths, is_override)
     else:

neosca/scaplatform.py

@@ -6,7 +6,7 @@
 import sys
 
 IS_WINDOWS = sys.platform == "win32"
-IS_DARWIN = sys.platform == "darwin"
+IS_MAC = sys.platform == "darwin"
 IS_LINUX = sys.platform == "linux"
 user_home = os_path.expanduser("~")
 if IS_WINDOWS:  # pragma: no cover