Spring/spring-security
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Remove superfluous comments

Browse Source 
Use '^\s+//\ \~\ .*$' and '^\s+//\ ============+$' regular expression
searches to remove superfluous comments.

Prior to this commit, many classes would have comments to indicate
blocks of code (such as constructors/methods/instance fields). These
added a lot of noise and weren't all that helpful, especially given
the outline views available in most modern IDEs.

Issue gh-8945
This commit is contained in:
Phillip Webb
2020-07-23 15:09:07 -07:00
committed by Rob Winch
parent b7fc18262d
commit 71bc145ae4
406 changed files with 12 additions and 2190 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
acl/src/test/java/org/springframework/security/acls/AclFormattingUtilsTests.java
View File

@@ -29,8 +29,6 @@ import org.springframework.security.acls.model.Permission;
*/
public class AclFormattingUtilsTests {
// ~ Methods
// ========================================================================================================
@Test
public final void testDemergePatternsParametersConstraints() {
try {

3
acl/src/test/java/org/springframework/security/acls/domain/AccessControlImplEntryTests.java
View File

@@ -32,9 +32,6 @@ import org.springframework.security.acls.model.Sid;
*/
public class AccessControlImplEntryTests {
// ~ Methods
// ========================================================================================================
@Test
public void testConstructorRequiredFields() {
// Check Acl field is present

6
acl/src/test/java/org/springframework/security/acls/domain/AclImplTests.java
View File

@@ -62,9 +62,6 @@ public class AclImplTests {
private DefaultPermissionFactory permissionFactory;
// ~ Methods
// ========================================================================================================
@Before
public void setUp() {
SecurityContextHolder.getContext().setAuthentication(auth);
@@ -540,9 +537,6 @@ public class AclImplTests {
ace.hashCode();
}
// ~ Inner Classes
// ==================================================================================================
private static class MaskPermissionGrantingStrategy extends DefaultPermissionGrantingStrategy {
MaskPermissionGrantingStrategy(AuditLogger auditLogger) {

3
acl/src/test/java/org/springframework/security/acls/domain/AclImplementationSecurityCheckTests.java
View File

@@ -38,9 +38,6 @@ public class AclImplementationSecurityCheckTests {
private static final String TARGET_CLASS = "org.springframework.security.acls.TargetObject";
// ~ Methods
// ========================================================================================================
@Before
public void setUp() {
SecurityContextHolder.clearContext();

5
acl/src/test/java/org/springframework/security/acls/domain/AuditLoggerTests.java
View File

@@ -34,8 +34,6 @@ import org.springframework.security.acls.model.AuditableAccessControlEntry;
*/
public class AuditLoggerTests {
// ~ Instance fields
// ================================================================================================
private PrintStream console;
private ByteArrayOutputStream bytes = new ByteArrayOutputStream();
@@ -44,9 +42,6 @@ public class AuditLoggerTests {
private AuditableAccessControlEntry ace;
// ~ Methods
// ========================================================================================================
@Before
public void setUp() {
logger = new ConsoleAuditLogger();

6
acl/src/test/java/org/springframework/security/acls/domain/ObjectIdentityImplTests.java
View File

@@ -32,9 +32,6 @@ public class ObjectIdentityImplTests {
private static final String DOMAIN_CLASS = "org.springframework.security.acls.domain.ObjectIdentityImplTests$MockIdDomainObject";
// ~ Methods
// ========================================================================================================
@Test
public void constructorsRespectRequiredFields() {
// Check one-argument constructor required field
@@ -177,9 +174,6 @@ public class ObjectIdentityImplTests {
assertThat(obj).isNotEqualTo(obj2);
}
// ~ Inner Classes
// ==================================================================================================
private class MockIdDomainObject {
private Object id;

4
acl/src/test/java/org/springframework/security/acls/domain/ObjectIdentityRetrievalStrategyImplTests.java
View File

@@ -28,8 +28,6 @@ import org.springframework.security.acls.model.ObjectIdentityRetrievalStrategy;
*/
public class ObjectIdentityRetrievalStrategyImplTests {
// ~ Methods
// ========================================================================================================
@Test
public void testObjectIdentityCreation() {
MockIdDomainObject domain = new MockIdDomainObject();
@@ -42,8 +40,6 @@ public class ObjectIdentityRetrievalStrategyImplTests {
assertThat(new ObjectIdentityImpl(domain)).isEqualTo(identity);
}
// ~ Inner Classes
// ==================================================================================================
@SuppressWarnings("unused")
private class MockIdDomainObject {

6
acl/src/test/java/org/springframework/security/acls/jdbc/AbstractBasicLookupStrategyTests.java
View File

@@ -56,16 +56,10 @@ public abstract class AbstractBasicLookupStrategyTests {
protected static final Long OBJECT_IDENTITY_LONG_AS_UUID = 110L;
// ~ Instance fields
// ================================================================================================
private BasicLookupStrategy strategy;
private static CacheManager cacheManager;
// ~ Methods
// ========================================================================================================
public abstract JdbcTemplate getJdbcTemplate();
public abstract DataSource getDataSource();

3
acl/src/test/java/org/springframework/security/acls/jdbc/DatabaseSeeder.java
View File

@@ -33,9 +33,6 @@ import javax.sql.DataSource;
*/
public class DatabaseSeeder {
// ~ Constructors
// ===================================================================================================
public DatabaseSeeder(DataSource dataSource, Resource resource) throws IOException {
Assert.notNull(dataSource, "dataSource required");
Assert.notNull(resource, "resource required");

3
acl/src/test/java/org/springframework/security/acls/jdbc/JdbcAclServiceTests.java
View File

@@ -112,9 +112,6 @@ public class JdbcAclServiceTests {
assertThat(objectIdentities).isNull();
}
// ~ Some integration tests
// ========================================================================================================
@Test
public void findChildrenWithoutIdType() {
ObjectIdentity objectIdentity = new ObjectIdentityImpl(MockLongIdDomainObject.class, 4711L);

9
acl/src/test/java/org/springframework/security/acls/jdbc/JdbcMutableAclServiceTests.java
View File

@@ -64,18 +64,12 @@ import org.springframework.transaction.annotation.Transactional;
@ContextConfiguration(locations = { "/jdbcMutableAclServiceTests-context.xml" })
public class JdbcMutableAclServiceTests extends AbstractTransactionalJUnit4SpringContextTests {
// ~ Constant fields
// ================================================================================================
private static final String TARGET_CLASS = TargetObject.class.getName();
private final Authentication auth = new TestingAuthenticationToken("ben", "ignored", "ROLE_ADMINISTRATOR");
public static final String SELECT_ALL_CLASSES = "SELECT * FROM acl_class WHERE class = ?";
// ~ Instance fields
// ================================================================================================
private final ObjectIdentity topParentOid = new ObjectIdentityImpl(TARGET_CLASS, 100L);
private final ObjectIdentity middleParentOid = new ObjectIdentityImpl(TARGET_CLASS, 101L);
@@ -97,9 +91,6 @@ public class JdbcMutableAclServiceTests extends AbstractTransactionalJUnit4Sprin
@Autowired
private JdbcTemplate jdbcTemplate;
// ~ Methods
// ========================================================================================================
protected String getSqlClassPathResource() {
return "createAclSchema.sql";
}

3
acl/src/test/java/org/springframework/security/acls/sid/SidRetrievalStrategyTests.java
View File

@@ -42,9 +42,6 @@ public class SidRetrievalStrategyTests {
Authentication authentication = new TestingAuthenticationToken("scott", "password", "A", "B", "C");
// ~ Methods
// ========================================================================================================
@Test
public void correctSidsAreRetrieved() {
SidRetrievalStrategy retrStrategy = new SidRetrievalStrategyImpl();

2
acl/src/test/java/org/springframework/security/acls/sid/SidTests.java
View File

@@ -34,8 +34,6 @@ import java.util.Collections;
public class SidTests {
// ~ Methods
// ========================================================================================================
@Test
public void testPrincipalSidConstructorsRequiredFields() {
// Check one String-argument constructor