org.codenarc.rule.gosu.GosuObjectEqualityRule.groovy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of gs-codenarc-ext Show documentation

A CodeNarc extension library for gosu.

There is a newer version: 1.1.2

/*
* Copyright 2010 the original author or authors.
*
* 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
*
*      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.
*/

package org.codenarc.rule.gosu

import org.codenarc.rule.AbstractRule
import org.codenarc.source.SourceCode
import org.codenarc.util.gosu.GosuUtil

/**
* Check for incorrect usage of checking for object equality by using Objects themselves instead of PublicID
*/
class GosuObjectEqualityRule extends AbstractRule {
   String name = 'GosuObjectEquality'
   String description = 'Incorrect usage of checking for object equality by using Objects themselves instead of PublicID'
   int priority = 1
   
   void applyTo(SourceCode sourceCode, List violations) {
	   
	   def withinBlockComment = false
	   sourceCode.getLines().eachWithIndex { obj, i ->
		   
		   // Check for block comments and ignore until block finished
		   if (GosuUtil.isStartOfBlockComment(obj)) {
			   withinBlockComment = true
		   }
		   if (GosuUtil.isEndOfBlockComment(obj)) {
			   withinBlockComment = false
		   }

		   if (!withinBlockComment && 
			   !GosuUtil.isBlankLine(obj) && 
			   !GosuUtil.isInlineCommented(obj) &&
			   isIncorrectObjectEqualityUse(obj) ) {
			   		violations << createViolation(i+1, null, "Incorrect usage of checking for object equality at line ${i+1}")
			   }    		   
	   }
   }
	   
   /**
    * Find instances of the pattern == ( "" eg. == Group( "xx:123" /* xxxx /* )
    */
   private boolean isIncorrectObjectEqualityUse(String textLine) {
		return ( textLine.trim() =~ /== *[a-zA-Z]* *\( *"[^"]* */ ) ? true : false
	}	      
}