Merge pull request #5805 from junichi11/php-psr1-for-enum

Fix PSR1Hint for Enum

php/php.editor/src/org/netbeans/modules/php/editor/verification/PSR1Hint.java

@@ -34,6 +34,7 @@
 import org.netbeans.modules.php.editor.parser.astnodes.ClassDeclaration;
 import org.netbeans.modules.php.editor.parser.astnodes.ConstantDeclaration;
 import org.netbeans.modules.php.editor.parser.astnodes.EmptyStatement;
+import org.netbeans.modules.php.editor.parser.astnodes.EnumDeclaration;
 import org.netbeans.modules.php.editor.parser.astnodes.FieldAccess;
 import org.netbeans.modules.php.editor.parser.astnodes.FunctionDeclaration;
 import org.netbeans.modules.php.editor.parser.astnodes.Identifier;
@@ -239,6 +240,14 @@ public void visit(TraitDeclaration node) {
                 processTypeDeclaration(node);
             }
 
+            @Override
+            public void visit(EnumDeclaration node) {
+                if (CancelSupport.getDefault().isCancelled()) {
+                    return;
+                }
+                processTypeDeclaration(node);
+            }
+
             @NbBundle.Messages("PSR1TypeDeclarationMoreTypesHintText=Each type MUST be in a file by itself.")
             private void processTypeDeclaration(TypeDeclaration node) {
                 Identifier typeNameNode = node.getName();

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumNotOk_01/EnumName.php

@@ -0,0 +1,24 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+enum EnumName {
+
+    const foo_bar = 1;
+    case Case1;
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumNotOk_01/EnumName.php.testConstantNameEnumNotOk_01.hints

@@ -0,0 +1,4 @@
+    const foo_bar = 1;
+          -------
+HINT:PSR-1 Violation:
+Class constants MUST be declared in all upper case with underscore separators.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumNotOk_02/EnumName.php

@@ -0,0 +1,25 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+enum EnumName {
+
+    const _BAR = 1;
+    case Case1;
+
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumNotOk_02/EnumName.php.testConstantNameEnumNotOk_02.hints

@@ -0,0 +1,4 @@
+    const _BAR = 1;
+          ----
+HINT:PSR-1 Violation:
+Class constants MUST be declared in all upper case with underscore separators.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumNotOk_03/EnumName.php

@@ -0,0 +1,25 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+enum EnumName {
+
+    const foobar = 1;
+    case Case1;
+
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumNotOk_03/EnumName.php.testConstantNameEnumNotOk_03.hints

@@ -0,0 +1,4 @@
+    const foobar = 1;
+          ------
+HINT:PSR-1 Violation:
+Class constants MUST be declared in all upper case with underscore separators.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumOk_01/EnumName.php

@@ -0,0 +1,25 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+enum EnumName {
+
+    const FOO_BAR = 1;
+    case Case1;
+
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumOk_01/EnumName.php.testConstantNameEnumOk_01.hints

@@ -0,0 +1 @@
+

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumOk_02/EnumName.php

@@ -0,0 +1,25 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+enum EnumName {
+
+    const FOOBAR = 1;
+    case Case1;
+
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testConstantNameEnumOk_02/EnumName.php.testConstantNameEnumOk_02.hints

@@ -0,0 +1 @@
+

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOkNamespace_01/EnumName.php

@@ -0,0 +1,22 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+enum EnumName {
+    case Case1;
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOkNamespace_01/EnumName.php.testEnumNameNotOkNamespace_01.hints

@@ -0,0 +1,4 @@
+enum EnumName {
+     --------
+HINT:PSR-1 Violation:
+Each type MUST be in a namespace of at least one level: a top-level vendor name.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOkNamespace_02/EnumName.php

@@ -0,0 +1,24 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+namespace {
+    enum EnumName {
+        case Case1;
+    }
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOkNamespace_02/EnumName.php.testEnumNameNotOkNamespace_02.hints

@@ -0,0 +1,4 @@
+    enum EnumName {
+         --------
+HINT:PSR-1 Violation:
+Each type MUST be in a namespace of at least one level: a top-level vendor name.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOk_01/EnumName.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+namespace Vendor;
+enum Enum_Name {
+    case Case1;
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOk_01/EnumName.php.testEnumNameNotOk_01.hints

@@ -0,0 +1,4 @@
+enum Enum_Name {
+     ---------
+HINT:PSR-1 Violation:
+Type names MUST be declared in StudlyCaps.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOk_02/EnumName.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+namespace Vendor;
+enum enumName {
+    case Case1;
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOk_02/EnumName.php.testEnumNameNotOk_02.hints

@@ -0,0 +1,4 @@
+enum enumName {
+     --------
+HINT:PSR-1 Violation:
+Type names MUST be declared in StudlyCaps.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOneDeclaration_01/EnumName.php

@@ -0,0 +1,32 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+namespace Vendor;
+
+enum Test {
+
+    case Case1;
+
+}
+
+enum EnumName {
+
+    case Case1;
+
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameNotOneDeclaration_01/EnumName.php.testEnumNameNotOneDeclaration_01.hints

@@ -0,0 +1,4 @@
+enum EnumName {
+     --------
+HINT:PSR-1 Violation:
+Each type MUST be in a file by itself.

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameOk_01/EnumName.php

@@ -0,0 +1,23 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+namespace Vendor;
+enum EnumName {
+    case Case1;
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testEnumNameOk_01/EnumName.php.testEnumNameOk_01.hints

@@ -0,0 +1 @@
+

php/php.editor/test/unit/data/testfiles/verification/PSR1/testMethodEnumNotOk_01/EnumName.php

@@ -0,0 +1,28 @@
+<?php
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you 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
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * 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.
+ */
+enum EnumName {
+
+    case Case1;
+
+    function foo_bar() {
+
+    }
+
+}

php/php.editor/test/unit/data/testfiles/verification/PSR1/testMethodEnumNotOk_01/EnumName.php.testMethodEnumNotOk_01.hints

@@ -0,0 +1,4 @@
+    function foo_bar() {
+             -------
+HINT:PSR-1 Violation:
+Method names MUST be declared in camelCase().