Cruft ruff update (ScreenPyHQ#148)

bandophahita · web-flow · commit d35ff7c213bd · 2025-01-21T20:15:06.000-06:00
* cruft udpate - ruff version and makefile shortcuts
* updated deps
* ruff rules updated
* updated copyright dates
diff --git a/.cruft.json b/.cruft.json
@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/ScreenPyHQ/cookiecutter_screenpy/",
-  "commit": "4ad86820b5729801d7c765e04cfda2e953671164",
+  "commit": "96416427ba79a718959084081e3b5d6a8860336a",
   "checkout": null,
   "context": {
     "cookiecutter": {
@@ -11,7 +11,8 @@
       "author": "Perry Goy",
       "author_email": "perry.goy@gmail.com",
       "github_username": "ScreenPyHQ",
-      "_template": "https://github.com/ScreenPyHQ/cookiecutter_screenpy/"
+      "_template": "https://github.com/ScreenPyHQ/cookiecutter_screenpy/",
+      "_commit": "96416427ba79a718959084081e3b5d6a8860336a"
     }
   },
   "directory": null
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -8,7 +8,7 @@ repos:
         language_version: python3.12
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.5.5
+    rev: v0.9.2
     hooks:
       - id: ruff
   - repo: https://github.com/pre-commit/mirrors-mypy
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019-2024 Perry Goy
+Copyright (c) 2019-2025 Perry Goy
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/Makefile b/Makefile
@@ -41,3 +41,8 @@ requirements:
 	poetry export --without-hashes --extras dev -f requirements.txt > requirements.txt
 
 .PHONY: requirements
+
+cruft-update:
+	cruft update --allow-untracked-files
+
+.PHONY: cruft-update
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -87,8 +87,6 @@ ignore = [
     "D107",  # missing __init__ docstring, we do that in the class docstring.
     "D203",  # one blank line before class docstring, no thanks!
     "D212",  # multi line summary first line, we want a one line summary.
-    "ANN101",  # missing self annotation, we only annotate self when we return it.
-    "ANN102",  # missing cls annotation, we only annotate cls when we return it.
 ]
 
 extend-safe-fixes = [
@@ -123,6 +121,7 @@ split-on-trailing-comma = false
     "D",  # we don't need public-API-polished docstrings in tests.
     "FBT",  # using a boolean as a test object is useful!
     "PLR",  # likewise using specific numbers and strings in tests.
+    "A",    # import __doc__ is shadowing python builtin
 ]
 "__version__.py" = ["D"]
 
diff --git a/screenpy/__init__.py b/screenpy/__init__.py
@@ -15,7 +15,7 @@
 ScreenPy is a composition-based test framework. It is inspired by the
 SerenityBDD library for Java.
 
-:copyright: (c) 2019-2024 by Perry Goy.
+:copyright: (c) 2019-2025 by Perry Goy.
 :license: MIT, see LICENSE for more details.
 """
 
@@ -60,41 +60,41 @@
 
 __all__ = [
     "AbilityError",
-    "act",
     "ActionError",
     "Actor",
     "Adapter",
     "AnActor",
-    "and_",
     "Answerable",
-    "aside",
-    "beat",
     "DeliveryError",
     "Describable",
     "Director",
     "ErrorKeeper",
     "Forgettable",
-    "given",
-    "given_that",
     "NotAnswerable",
-    "noted",
-    "noted_under",
     "NotPerformable",
     "NotResolvable",
     "Performable",
     "QuestionError",
     "Resolvable",
-    "scene",
     "ScreenPyError",
-    "settings",
-    "the_narrator",
-    "the_noted",
-    "then",
     "UnableToAct",
     "UnableToAnswer",
     "UnableToDirect",
     "UnableToNarrate",
     "UnableToPerform",
+    "act",
+    "and_",
+    "aside",
+    "beat",
+    "given",
+    "given_that",
+    "noted",
+    "noted_under",
+    "scene",
+    "settings",
+    "the_narrator",
+    "the_noted",
+    "then",
     "when",
 ]
 __all__ += actions.__all__ + resolutions.__all__ + narration.__all__
diff --git a/screenpy/__version__.py b/screenpy/__version__.py
@@ -18,4 +18,4 @@
 __author__ = metadata["Author"]
 __author_email__ = metadata["Author-email"]
 __license__ = metadata["License"]
-__copyright__ = f"2019-2024 {__author__}"
+__copyright__ = f"2019-2025 {__author__}"
diff --git a/screenpy/actions/__init__.py b/screenpy/actions/__init__.py
@@ -40,15 +40,15 @@
     "AssertsAllOf",
     "AssertsAnyOf",
     "AttachAFile",
+    "AttachFile",
+    "AttachTheFile",
     "AttachesAFile",
     "AttachesFile",
     "AttachesTheFile",
-    "AttachFile",
-    "AttachTheFile",
     "Attempt",
+    "AttemptTo",
     "Attempts",
     "AttemptsTo",
-    "AttemptTo",
     "Confirm",
     "ConfirmAllOf",
     "ConfirmAnyOf",
@@ -58,8 +58,8 @@
     "Debug",
     "Either",
     "Eventually",
-    "GoesFor",
     "GoFor",
+    "GoesFor",
     "Log",
     "MakeNote",
     "MakesNote",
diff --git a/screenpy/narration/__init__.py b/screenpy/narration/__init__.py
@@ -9,9 +9,9 @@
     "EXTREME",
     "HEAVY",
     "LIGHT",
+    "NORMAL",
     "LoggingAdapter",
     "Narrator",
-    "NORMAL",
     "StdOutAdapter",
     "StdOutManager",
 ]
diff --git a/screenpy/narration/stdout_adapter/__init__.py b/screenpy/narration/stdout_adapter/__init__.py
@@ -7,7 +7,7 @@
 
 __all__ = [
     "LoggingAdapter",
-    "settings",
     "StdOutAdapter",
     "StdOutManager",
+    "settings",
 ]
diff --git a/screenpy/resolutions/__init__.py b/screenpy/resolutions/__init__.py
@@ -52,27 +52,27 @@
 __all__ = [
     "BaseResolution",
     "ContainItemMatching",
+    "ContainTheEntries",
+    "ContainTheEntry",
+    "ContainTheItem",
+    "ContainTheKey",
+    "ContainTheText",
+    "ContainTheValue",
     "ContainsItemMatching",
     "ContainsTheEntries",
     "ContainsTheEntry",
     "ContainsTheItem",
     "ContainsTheKey",
     "ContainsTheText",
     "ContainsTheValue",
-    "ContainTheEntries",
-    "ContainTheEntry",
-    "ContainTheItem",
-    "ContainTheKey",
-    "ContainTheText",
-    "ContainTheValue",
-    "DoesNot",
     "DoNot",
+    "DoesNot",
     "Empty",
-    "EndsWith",
     "EndWith",
+    "EndsWith",
     "Equal",
-    "Equals",
     "EqualTo",
+    "Equals",
     "GreaterThan",
     "GreaterThanOrEqualTo",
     "HasLength",
@@ -93,6 +93,6 @@
     "Matches",
     "ReadExactly",
     "ReadsExactly",
-    "StartsWith",
     "StartWith",
+    "StartsWith",
 ]
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -6,15 +6,15 @@
 from screenpy import Actor, Narrator, pacing
 
 
-@pytest.fixture()
+@pytest.fixture
 def Tester() -> Generator[Actor, None, None]:
     """Provide an Actor with mocked web browsing abilities."""
     the_actor = Actor.named("Tester")
     yield the_actor
     the_actor.exit()
 
 
-@pytest.fixture()
+@pytest.fixture
 def mocked_narrator() -> Generator[mock.MagicMock, Any, None]:
     """Mock out the Narrator for a test, replacing the old one afterwards."""
     mock_narrator = mock.create_autospec(Narrator, instance=True)

Original file line number	Diff line number	Diff line change
`@@ -87,8 +87,6 @@ ignore = [`
`87`	`87`	`"D107", # missing __init__ docstring, we do that in the class docstring.`
`88`	`88`	`"D203", # one blank line before class docstring, no thanks!`
`89`	`89`	`"D212", # multi line summary first line, we want a one line summary.`
`90`		`- "ANN101", # missing self annotation, we only annotate self when we return it.`
`91`		`- "ANN102", # missing cls annotation, we only annotate cls when we return it.`
`92`	`90`	`]`
`93`	`91`
`94`	`92`	`extend-safe-fixes = [`
`@@ -123,6 +121,7 @@ split-on-trailing-comma = false`
`123`	`121`	`"D", # we don't need public-API-polished docstrings in tests.`
`124`	`122`	`"FBT", # using a boolean as a test object is useful!`
`125`	`123`	`"PLR", # likewise using specific numbers and strings in tests.`
	`124`	`+ "A", # import __doc__ is shadowing python builtin`
`126`	`125`	`]`
`127`	`126`	`"__version__.py" = ["D"]`
`128`	`127`