Support special acronyms inside property names and allow plural forms

[Wizard]

resolve conflict in doc

[hokein]

LGTM

[benhamilton]

Can you add test cases for non-plural acronyms in the middle of the string and plural acronyms at the start/end of the string, please?

clang-tidy/objc/PropertyDeclarationCheck.cpp

139–141

Why do we not allow plural acronyms at the start of the property name? For example:

@property(nonatomic) NSArray<NSString *> *URLsToFetch;

should be allowed.

141

Why do we not allow singular acronyms in the middle of the property name?

I think we should allow singular and plural acronyms anywhere.

[Wizard]

resolve comments

clang-tidy/objc/PropertyDeclarationCheck.cpp

139–141

Hmm I was thinking that prefix should not have plural form. Will enable plural forms everywhere.

141

Actually we do. AcronymsGroupRegex(EscapedAcronyms, true) will support both while AcronymsGroupRegex(EscapedAcronyms, false) only supports singular. Will update test cases.

[benhamilton]

clang-tidy/objc/PropertyDeclarationCheck.cpp

139

Since AcronymsGroupRegex() is called twice with the same parameter, please store the result in a local variable instead of doing the work twice.

141

Ah, this is why I find boolean flags to be confusing :) Anyway, it's gone now.

test/clang-tidy/objc-property-declaration.m

12

Add a check for a plural at the end, please.

[Wizard]

minor fix according to comments

clang-tidy/objc/PropertyDeclarationCheck.cpp

 //===--- PropertyDeclarationCheck.cpp - clang-tidy-------------------------===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 
 #include "PropertyDeclarationCheck.h"
 #include <algorithm>
 #include "../utils/OptionsUtils.h"
 #include "clang/AST/ASTContext.h"
 #include "clang/ASTMatchers/ASTMatchFinder.h"
-#include "llvm/ADT/STLExtras.h"
 #include "clang/Basic/CharInfo.h"
+#include "llvm/ADT/STLExtras.h"
 #include "llvm/ADT/StringExtras.h"
 #include "llvm/Support/Regex.h"
 
 using namespace clang::ast_matchers;
 
 namespace clang {
 namespace tidy {
 namespace objc {
if (NewName != Name) {
       return FixItHint::CreateReplacement(
           CharSourceRange::getTokenRange(SourceRange(Decl->getLocation())),
           llvm::StringRef(NewName));
     }
   }
   return FixItHint();
 }
 
+std::string AcronymsGroupRegex(llvm::ArrayRef<std::string> EscapedAcronyms) {
+  return "(" +
+         llvm::join(EscapedAcronyms.begin(), EscapedAcronyms.end(), "s?|") +
+         "s?)";
+}
+
 std::string validPropertyNameRegex(llvm::ArrayRef<std::string> EscapedAcronyms,
                                    bool UsedInMatcher) {
   // Allow any of these names:
   // foo
   // fooBar
   // url
   // urlString
   // URL
   // URLString
   // bundleID
   std::string StartMatcher = UsedInMatcher ? "::" : "^";
 
-  return StartMatcher + "((" +
-         llvm::join(EscapedAcronyms.begin(), EscapedAcronyms.end(), "|") +
-         ")[A-Z]?)?[a-z]+[a-z0-9]*([A-Z][a-z0-9]+)*" + "(" +
-         llvm::join(EscapedAcronyms.begin(), EscapedAcronyms.end(), "|") +
-         ")?$";
+  return StartMatcher + "(" + AcronymsGroupRegex(EscapedAcronyms) +
+         "[A-Z]?)?[a-z]+[a-z0-9]*(" + AcronymsGroupRegex(EscapedAcronyms) +
+         "|([A-Z][a-z0-9]+))*$";
 }
 
 bool hasCategoryPropertyPrefix(llvm::StringRef PropertyName) {
   auto RegexExp = llvm::Regex("^[a-zA-Z]+_[a-zA-Z0-9][a-zA-Z0-9_]+$");
   return RegexExp.match(PropertyName);
 }
 
 bool prefixedPropertyNameValid(llvm::StringRef PropertyName,

test/clang-tidy/objc-property-declaration.m

 // RUN: %check_clang_tidy %s objc-property-declaration %t
 @class NSData;
 @class NSString;
 @class UIViewController;
 
 @interface Foo
 @property(assign, nonatomic) int NotCamelCase;
 // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
 // CHECK-FIXES: @property(assign, nonatomic) int notCamelCase;
 @property(assign, nonatomic) int camelCase;
 @property(strong, nonatomic) NSString *URLString;
 @property(strong, nonatomic) NSString *bundleID;
 @property(strong, nonatomic) NSData *RGBABytes;
 @property(strong, nonatomic) UIViewController *notificationsVC;
 @property(strong, nonatomic) NSString *URL_string;
 // CHECK-MESSAGES: :[[@LINE-1]]:40: warning: property name 'URL_string' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
+@property(strong, nonatomic) NSString *supportURLsCamelCase;
+@property(strong, nonatomic) NSString *supportURLCamelCase;
+@property(strong, nonatomic) NSString *VCsPluralToAdd;
 @end
 
 @interface Foo (Bar)
 @property(assign, nonatomic) int abc_NotCamelCase;
 // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abc_NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
 @property(assign, nonatomic) int abCD_camelCase;
 // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abCD_camelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
 // CHECK-FIXES: @property(assign, nonatomic) int abcd_camelCase;
 @property(assign, nonatomic) int abCD_NotCamelCase;
 // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abCD_NotCamelCase' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
 // CHECK-FIXES: @property(assign, nonatomic) int abcd_notCamelCase;
 @property(assign, nonatomic) int wrongFormat_;
 // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'wrongFormat_' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
 @property(strong, nonatomic) NSString *URLStr;
 @property(assign, nonatomic) int abc_camelCase;
 @end
 
 @interface Foo ()
 @property(assign, nonatomic) int abc_inClassExtension;
 // CHECK-MESSAGES: :[[@LINE-1]]:34: warning: property name 'abc_inClassExtension' not using lowerCamelCase style or not prefixed in a category, according to the Apple Coding Guidelines [objc-property-declaration]
 @end
 No newline at end of file