Enable serialization of Python SpacesStyle

knutwannheden · knutwannheden · commit 56ace3fa8311 · 2024-11-28T19:42:13.000+01:00
diff --git a/rewrite-python/src/main/java/org/openrewrite/python/style/PythonStyle.java b/rewrite-python/src/main/java/org/openrewrite/python/style/PythonStyle.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2024 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.python.style;
+
+import org.openrewrite.style.Style;
+
+public interface PythonStyle extends Style {
+}
diff --git a/rewrite-python/src/main/java/org/openrewrite/python/style/SpacesStyle.java b/rewrite-python/src/main/java/org/openrewrite/python/style/SpacesStyle.java
@@ -0,0 +1,84 @@
+/*
+ * Copyright 2024 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.openrewrite.python.style;
+
+import lombok.Value;
+import lombok.With;
+
+import java.util.UUID;
+
+@Value
+@With
+public class SpacesStyle implements PythonStyle {
+
+    UUID id;
+    BeforeParentheses beforeParentheses;
+    AroundOperators aroundOperators;
+    Within within;
+    Other other;
+
+    @Value
+    @With
+    public static class BeforeParentheses {
+        Boolean methodDeclaration;
+        Boolean methodCall;
+        Boolean leftBracket;
+    }
+
+    @Value
+    @With
+    public static class AroundOperators {
+        Boolean assignment;
+        Boolean equality;
+        Boolean relational;
+        Boolean bitwise;
+        Boolean additive;
+        Boolean multiplicative;
+        Boolean shift;
+        Boolean power;
+        Boolean eqInNamedParameter;
+        Boolean eqInKeywordArgument;
+    }
+
+    @Value
+    @With
+    public static class Within {
+        Boolean brackets;
+        Boolean methodDeclarationParentheses;
+        Boolean emptyMethodDeclarationParentheses;
+        Boolean methodCallParentheses;
+        Boolean emptyMethodCallParentheses;
+        Boolean braces;
+    }
+
+    @Value
+    @With
+    public static class Other {
+        Boolean beforeComma;
+        Boolean afterComma;
+        Boolean beforeForSemicolon;
+        Boolean beforeColon;
+        Boolean afterColon;
+        Boolean beforeBackslash;
+        Boolean beforeHash;
+        Boolean afterHash;
+    }
+
+//    @Override
+//    public Style applyDefaults() {
+//        return StyleHelper.merge(IntelliJ.spaces(), this);
+//    }
+}
diff --git a/rewrite-python/src/main/java/org/openrewrite/python/style/package-info.java b/rewrite-python/src/main/java/org/openrewrite/python/style/package-info.java
@@ -0,0 +1,21 @@
+/*
+ * Copyright 2024 the original author or authors.
+ * <p>
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ * <p>
+ * https://www.apache.org/licenses/LICENSE-2.0
+ * <p>
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+@NullMarked
+@NonNullFields
+package org.openrewrite.python.style;
+
+import org.jspecify.annotations.NullMarked;
+import org.openrewrite.internal.lang.NonNullFields;
diff --git a/rewrite/rewrite/python/format/auto_format.py b/rewrite/rewrite/python/format/auto_format.py
@@ -30,5 +30,5 @@ def __init__(self, style: SpacesStyle, stop_after: Tree = None):
 
     def visit_method_declaration(self, method_declaration: MethodDeclaration, p: P) -> J:
         return method_declaration.padding.with_parameters(
-            method_declaration.padding.parameters.with_before(Space.SINGLE_SPACE if self._style.beforeParentheses.method_parentheses else Space.EMPTY)
+            method_declaration.padding.parameters.with_before(Space.SINGLE_SPACE if self._style.beforeParentheses._method_declaration else Space.EMPTY)
         )
diff --git a/rewrite/rewrite/python/style.py b/rewrite/rewrite/python/style.py
@@ -1,52 +1,53 @@
 from dataclasses import dataclass
+from typing import Protocol
 
 from ..style import Style, NamedStyles
 
 
-class PythonStyle(Style):
+class PythonStyle(Style, Protocol):
     pass
 
 
 @dataclass(frozen=True)
 class SpacesStyle(PythonStyle):
     @dataclass(frozen=True)
     class BeforeParentheses:
-        method_call_parentheses: bool
-        method_parentheses: bool
-        left_bracket: bool
+        _method_call: bool
+        _method_declaration: bool
+        _left_bracket: bool
 
     @dataclass(frozen=True)
     class AroundOperators:
-        assignment: bool
-        equality: bool
-        relational: bool
-        bitwise: bool
-        additive: bool
-        multiplicative: bool
-        shift: bool
-        power: bool
-        eq_in_named_parameter: bool
-        eq_in_keyword_argument: bool
+        _assignment: bool
+        _equality: bool
+        _relational: bool
+        _bitwise: bool
+        _additive: bool
+        _multiplicative: bool
+        _shift: bool
+        _power: bool
+        _eq_in_named_parameter: bool
+        _eq_in_keyword_argument: bool
 
     @dataclass(frozen=True)
     class Within:
-        brackets: bool
-        method_parentheses: bool
-        empty_method_parentheses: bool
-        method_call_parentheses: bool
-        empty_method_call_parentheses: bool
-        braces: bool
+        _brackets: bool
+        _method_declaration_parentheses: bool
+        _empty_method_declaration_parentheses: bool
+        _method_call_parentheses: bool
+        _empty_method_call_parentheses: bool
+        _braces: bool
 
     @dataclass(frozen=True)
     class Other:
-        before_comma: bool
-        after_comma: bool
-        before_for_semicolon: bool
-        before_colon: bool
-        after_colon: bool
-        before_backslash: bool
-        before_hash: bool
-        after_hash: bool
+        _before_comma: bool
+        _after_comma: bool
+        _before_for_semicolon: bool
+        _before_colon: bool
+        _after_colon: bool
+        _before_backslash: bool
+        _before_hash: bool
+        _after_hash: bool
 
     beforeParentheses: BeforeParentheses
     aroundOperators: AroundOperators
@@ -59,38 +60,38 @@ class IntelliJ(NamedStyles):
     def spaces(cls) -> SpacesStyle:
         return SpacesStyle(
             SpacesStyle.BeforeParentheses(
-                method_call_parentheses=False,
-                method_parentheses=False,
-                left_bracket=False,
+                _method_call=False,
+                _method_declaration=False,
+                _left_bracket=False,
             ),
             SpacesStyle.AroundOperators(
-                assignment=True,
-                equality=True,
-                relational=True,
-                bitwise=True,
-                additive=True,
-                multiplicative=True,
-                shift=True,
-                power=True,
-                eq_in_named_parameter=False,
-                eq_in_keyword_argument=False,
+                _assignment=True,
+                _equality=True,
+                _relational=True,
+                _bitwise=True,
+                _additive=True,
+                _multiplicative=True,
+                _shift=True,
+                _power=True,
+                _eq_in_named_parameter=False,
+                _eq_in_keyword_argument=False,
             ),
             SpacesStyle.Within(
-                brackets=False,
-                method_parentheses=False,
-                empty_method_parentheses=False,
-                method_call_parentheses=False,
-                empty_method_call_parentheses=False,
-                braces=False,
+                _brackets=False,
+                _method_declaration_parentheses=False,
+                _empty_method_declaration_parentheses=False,
+                _method_call_parentheses=False,
+                _empty_method_call_parentheses=False,
+                _braces=False,
             ),
             SpacesStyle.Other(
-                before_comma=False,
-                after_comma=True,
-                before_for_semicolon=False,
-                before_colon=False,
-                after_colon=True,
-                before_backslash=True,
-                before_hash=True,
-                after_hash=True,
+                _before_comma=False,
+                _after_comma=True,
+                _before_for_semicolon=False,
+                _before_colon=False,
+                _after_colon=True,
+                _before_backslash=True,
+                _before_hash=True,
+                _after_hash=True,
             ),
         )
diff --git a/rewrite/rewrite/style.py b/rewrite/rewrite/style.py
@@ -1,12 +1,13 @@
 from __future__ import annotations
 
 from dataclasses import dataclass, replace
-from typing import Protocol, TypeVar, Type, Iterable, Optional, Set
+from typing import Protocol, TypeVar, Type, Iterable, Optional, Set, runtime_checkable
 from uuid import UUID
 
 from rewrite import Marker, random_id
 
 
+@runtime_checkable
 class Style(Protocol):
     def merge(self, lower_precedence: Style) -> Style:
         return self
diff --git a/rewrite/tests/python/all/format/demo_test.py b/rewrite/tests/python/all/format/demo_test.py
@@ -1,8 +1,9 @@
 from typing import Optional
 
+from rewrite import NamedStyles
 from rewrite.java import Space, P
-from rewrite.python import PythonVisitor, AutoFormat
-from rewrite.test import rewrite_run, python, from_visitor
+from rewrite.python import PythonVisitor, AutoFormat, PythonParserBuilder, IntelliJ
+from rewrite.test import rewrite_run, python, from_visitor, RecipeSpec
 
 
 def test_remove_all_spaces_demo():
@@ -15,7 +16,9 @@ def getter(self, row):
                     pass
             """, """classFoo:defgetter(self,row):pass"""
         ),
-        recipe=from_visitor(NoSpaces())
+        spec=RecipeSpec()
+        .with_recipe(from_visitor(NoSpaces()))
+        .with_parsers([PythonParserBuilder().styles(NamedStyles.build(IntelliJ.spaces()))])
     )
 
 
@@ -34,7 +37,7 @@ def getter(self, row):
                     pass
             """
         ),
-        recipe=AutoFormat()
+        spec=RecipeSpec(_recipe=AutoFormat())
     )
 
 class NoSpaces(PythonVisitor):

Original file line number	Diff line number	Diff line change
`@@ -30,5 +30,5 @@ def __init__(self, style: SpacesStyle, stop_after: Tree = None):`
`30`	`30`
`31`	`31`	`def visit_method_declaration(self, method_declaration: MethodDeclaration, p: P) -> J:`
`32`	`32`	`return method_declaration.padding.with_parameters(`
`33`		`- method_declaration.padding.parameters.with_before(Space.SINGLE_SPACE if self._style.beforeParentheses.method_parentheses else Space.EMPTY)`
	`33`	`+ method_declaration.padding.parameters.with_before(Space.SINGLE_SPACE if self._style.beforeParentheses._method_declaration else Space.EMPTY)`
`34`	`34`	`)`