{"action":"created","comment":{"url":"https://api.github.com/repos/SonarSource/sonar-java/pulls/comments/23856384","id":23856384,"diff_hunk":"@@ -0,0 +1,110 @@\n+/*\n+ * SonarQube Java\n+ * Copyright (C) 2012 SonarSource\n+ * dev@sonar.codehaus.org\n+ *\n+ * This program is free software; you can redistribute it and/or\n+ * modify it under the terms of the GNU Lesser General Public\n+ * License as published by the Free Software Foundation; either\n+ * version 3 of the License, or (at your option) any later version.\n+ *\n+ * This program is distributed in the hope that it will be useful,\n+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\n+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU\n+ * Lesser General Public License for more details.\n+ *\n+ * You should have received a copy of the GNU Lesser General Public\n+ * License along with this program; if not, write to the Free Software\n+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02\n+ */\n+package org.sonar.java.checks;\n+\n+import com.google.common.collect.ImmutableList;\n+import com.sonar.sslr.api.AstNode;\n+import org.sonar.check.BelongsToProfile;\n+import org.sonar.check.Priority;\n+import org.sonar.check.Rule;\n+import org.sonar.java.model.declaration.MethodTreeImpl;\n+import org.sonar.java.model.declaration.VariableTreeImpl;\n+import org.sonar.java.model.expression.IdentifierTreeImpl;\n+import org.sonar.java.model.statement.ReturnStatementTreeImpl;\n+import org.sonar.java.resolve.Type;\n+import org.sonar.plugins.java.api.tree.BaseTreeVisitor;\n+import org.sonar.plugins.java.api.tree.ExpressionTree;\n+import org.sonar.plugins.java.api.tree.MemberSelectExpressionTree;\n+import org.sonar.plugins.java.api.tree.MethodTree;\n+import org.sonar.plugins.java.api.tree.ReturnStatementTree;\n+import org.sonar.plugins.java.api.tree.Tree;\n+import org.sonar.plugins.java.api.tree.Tree.Kind;\n+import org.sonar.plugins.java.api.tree.VariableTree;\n+\n+import java.util.List;\n+\n+@Rule(\n+  key = \"S2167\",\n+  priority = Priority.CRITICAL,\n+  tags = {\"bug\"})\n+@BelongsToProfile(title = \"Sonar way\", priority = Priority.CRITICAL)\n+public class CompareToReturnValueCheck extends SubscriptionBaseVisitor {\n+\n+  @Override\n+  public List<Kind> nodesToVisit() {\n+    return ImmutableList.of(Kind.METHOD);\n+  }\n+\n+  @Override\n+  public void visitNode(Tree tree) {\n+    MethodTree methodTree = (MethodTree) tree;\n+    if (isCompareToDeclaration(methodTree)) {\n+      methodTree.accept(new ReturnStatementVisitor(methodTree));\n+    }\n+  }\n+\n+  private boolean isCompareToDeclaration(MethodTree tree) {\n+    return isMethodName(tree, \"compareTo\") && hasOneNonPrimitiveParameter(tree) && returnsInt(tree);\n+  }\n+\n+  private boolean isMethodName(MethodTree methodTree, String name) {\n+    return name.equals(methodTree.simpleName().name());\n+  }\n+\n+  private boolean hasOneNonPrimitiveParameter(MethodTree methodTree) {\n+    List<VariableTree> parameters = methodTree.parameters();\n+    return parameters.size() == 1 && !((VariableTreeImpl) parameters.get(0)).getSymbol().getType().isPrimitive();\n+  }\n+\n+  private boolean returnsInt(MethodTree methodTree) {\n+    return ((MethodTreeImpl) methodTree).getSymbol().getReturnType().getType().isTagged(Type.INT);\n+  }\n+\n+  private class ReturnStatementVisitor extends BaseTreeVisitor {\n+\n+    private final AstNode callingMethod;\n+\n+    public ReturnStatementVisitor(MethodTree callingMethod) {\n+      this.callingMethod = ((MethodTreeImpl) callingMethod).getAstNode();\n+    }\n+\n+    @Override\n+    public void visitReturnStatement(ReturnStatementTree tree) {\n+      if (isWithinCallingMethodBody(tree) && returnsIntegerMinValue(tree.expression())) {\n+        addIssue(tree, \"Simply return -1\");\n+      }\n+      super.visitReturnStatement(tree);","path":"java-checks/src/main/java/org/sonar/java/checks/CompareToReturnValueCheck.java","position":null,"original_position":93,"commit_id":"dcc60cbc8a06049d8aabe08d44ff6a87c00ecb5d","original_commit_id":"77b2865168e891034a6785b0f1b4b4ffffb968eb","user":{"login":"benzonico","id":1199708,"avatar_url":"https://avatars.githubusercontent.com/u/1199708?v=3","gravatar_id":"","url":"https://api.github.com/users/benzonico","html_url":"https://github.com/benzonico","followers_url":"https://api.github.com/users/benzonico/followers","following_url":"https://api.github.com/users/benzonico/following{/other_user}","gists_url":"https://api.github.com/users/benzonico/gists{/gist_id}","starred_url":"https://api.github.com/users/benzonico/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/benzonico/subscriptions","organizations_url":"https://api.github.com/users/benzonico/orgs","repos_url":"https://api.github.com/users/benzonico/repos","events_url":"https://api.github.com/users/benzonico/events{/privacy}","received_events_url":"https://api.github.com/users/benzonico/received_events","type":"User","site_admin":false},"body":"uncessary call to super. No need to visit further.","created_at":"2015-01-30T17:17:19Z","updated_at":"2015-01-30T17:17:19Z","html_url":"https://github.com/SonarSource/sonar-java/pull/28#discussion_r23856384","pull_request_url":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28","_links":{"self":{"href":"https://api.github.com/repos/SonarSource/sonar-java/pulls/comments/23856384"},"html":{"href":"https://github.com/SonarSource/sonar-java/pull/28#discussion_r23856384"},"pull_request":{"href":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28"}}},"pull_request":{"url":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28","id":28012413,"html_url":"https://github.com/SonarSource/sonar-java/pull/28","diff_url":"https://github.com/SonarSource/sonar-java/pull/28.diff","patch_url":"https://github.com/SonarSource/sonar-java/pull/28.patch","issue_url":"https://api.github.com/repos/SonarSource/sonar-java/issues/28","number":28,"state":"open","locked":false,"title":"SONARJAVA-866 RSPEC-2167 CompareTo return value check","user":{"login":"m-g-sonar","id":10588758,"avatar_url":"https://avatars.githubusercontent.com/u/10588758?v=3","gravatar_id":"","url":"https://api.github.com/users/m-g-sonar","html_url":"https://github.com/m-g-sonar","followers_url":"https://api.github.com/users/m-g-sonar/followers","following_url":"https://api.github.com/users/m-g-sonar/following{/other_user}","gists_url":"https://api.github.com/users/m-g-sonar/gists{/gist_id}","starred_url":"https://api.github.com/users/m-g-sonar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/m-g-sonar/subscriptions","organizations_url":"https://api.github.com/users/m-g-sonar/orgs","repos_url":"https://api.github.com/users/m-g-sonar/repos","events_url":"https://api.github.com/users/m-g-sonar/events{/privacy}","received_events_url":"https://api.github.com/users/m-g-sonar/received_events","type":"User","site_admin":false},"body":"\"compareTo\" return value check\r\n\r\n- It is the sign, rather than the magnitude of the value returned from `compareTo` that matters. Returning `Integer.MIN_VALUE` does not convey a higher degree of inequality, and doing so can cause errors because the return value of `compareTo` is sometimes inversed, with the expectation that negative values become positive. However, inversing `Integer.MIN_VALUE` yields `Integer.MIN_VALUE` rather than `Integer.MAX_VALUE`.\r\n- The rule check the return value of the `compareTo` methods and add an issue if `Integer.MIN_VALUE` is returned.","created_at":"2015-01-26T08:51:03Z","updated_at":"2015-01-30T17:17:19Z","closed_at":null,"merged_at":null,"merge_commit_sha":"76c7caea7cc67dc14c57e6d0b6c00f2c90826dca","assignee":null,"milestone":null,"commits_url":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28/commits","review_comments_url":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28/comments","review_comment_url":"https://api.github.com/repos/SonarSource/sonar-java/pulls/comments/{number}","comments_url":"https://api.github.com/repos/SonarSource/sonar-java/issues/28/comments","statuses_url":"https://api.github.com/repos/SonarSource/sonar-java/statuses/dcc60cbc8a06049d8aabe08d44ff6a87c00ecb5d","head":{"label":"m-g-sonar:SONARJAVA-866_RSPEC-2167_CompareTo_return_value_check","ref":"SONARJAVA-866_RSPEC-2167_CompareTo_return_value_check","sha":"dcc60cbc8a06049d8aabe08d44ff6a87c00ecb5d","user":{"login":"m-g-sonar","id":10588758,"avatar_url":"https://avatars.githubusercontent.com/u/10588758?v=3","gravatar_id":"","url":"https://api.github.com/users/m-g-sonar","html_url":"https://github.com/m-g-sonar","followers_url":"https://api.github.com/users/m-g-sonar/followers","following_url":"https://api.github.com/users/m-g-sonar/following{/other_user}","gists_url":"https://api.github.com/users/m-g-sonar/gists{/gist_id}","starred_url":"https://api.github.com/users/m-g-sonar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/m-g-sonar/subscriptions","organizations_url":"https://api.github.com/users/m-g-sonar/orgs","repos_url":"https://api.github.com/users/m-g-sonar/repos","events_url":"https://api.github.com/users/m-g-sonar/events{/privacy}","received_events_url":"https://api.github.com/users/m-g-sonar/received_events","type":"User","site_admin":false},"repo":{"id":29524789,"name":"sonar-java","full_name":"m-g-sonar/sonar-java","owner":{"login":"m-g-sonar","id":10588758,"avatar_url":"https://avatars.githubusercontent.com/u/10588758?v=3","gravatar_id":"","url":"https://api.github.com/users/m-g-sonar","html_url":"https://github.com/m-g-sonar","followers_url":"https://api.github.com/users/m-g-sonar/followers","following_url":"https://api.github.com/users/m-g-sonar/following{/other_user}","gists_url":"https://api.github.com/users/m-g-sonar/gists{/gist_id}","starred_url":"https://api.github.com/users/m-g-sonar/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/m-g-sonar/subscriptions","organizations_url":"https://api.github.com/users/m-g-sonar/orgs","repos_url":"https://api.github.com/users/m-g-sonar/repos","events_url":"https://api.github.com/users/m-g-sonar/events{/privacy}","received_events_url":"https://api.github.com/users/m-g-sonar/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/m-g-sonar/sonar-java","description":"","fork":true,"url":"https://api.github.com/repos/m-g-sonar/sonar-java","forks_url":"https://api.github.com/repos/m-g-sonar/sonar-java/forks","keys_url":"https://api.github.com/repos/m-g-sonar/sonar-java/keys{/key_id}","collaborators_url":"https://api.github.com/repos/m-g-sonar/sonar-java/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/m-g-sonar/sonar-java/teams","hooks_url":"https://api.github.com/repos/m-g-sonar/sonar-java/hooks","issue_events_url":"https://api.github.com/repos/m-g-sonar/sonar-java/issues/events{/number}","events_url":"https://api.github.com/repos/m-g-sonar/sonar-java/events","assignees_url":"https://api.github.com/repos/m-g-sonar/sonar-java/assignees{/user}","branches_url":"https://api.github.com/repos/m-g-sonar/sonar-java/branches{/branch}","tags_url":"https://api.github.com/repos/m-g-sonar/sonar-java/tags","blobs_url":"https://api.github.com/repos/m-g-sonar/sonar-java/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/m-g-sonar/sonar-java/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/m-g-sonar/sonar-java/git/refs{/sha}","trees_url":"https://api.github.com/repos/m-g-sonar/sonar-java/git/trees{/sha}","statuses_url":"https://api.github.com/repos/m-g-sonar/sonar-java/statuses/{sha}","languages_url":"https://api.github.com/repos/m-g-sonar/sonar-java/languages","stargazers_url":"https://api.github.com/repos/m-g-sonar/sonar-java/stargazers","contributors_url":"https://api.github.com/repos/m-g-sonar/sonar-java/contributors","subscribers_url":"https://api.github.com/repos/m-g-sonar/sonar-java/subscribers","subscription_url":"https://api.github.com/repos/m-g-sonar/sonar-java/subscription","commits_url":"https://api.github.com/repos/m-g-sonar/sonar-java/commits{/sha}","git_commits_url":"https://api.github.com/repos/m-g-sonar/sonar-java/git/commits{/sha}","comments_url":"https://api.github.com/repos/m-g-sonar/sonar-java/comments{/number}","issue_comment_url":"https://api.github.com/repos/m-g-sonar/sonar-java/issues/comments/{number}","contents_url":"https://api.github.com/repos/m-g-sonar/sonar-java/contents/{+path}","compare_url":"https://api.github.com/repos/m-g-sonar/sonar-java/compare/{base}...{head}","merges_url":"https://api.github.com/repos/m-g-sonar/sonar-java/merges","archive_url":"https://api.github.com/repos/m-g-sonar/sonar-java/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/m-g-sonar/sonar-java/downloads","issues_url":"https://api.github.com/repos/m-g-sonar/sonar-java/issues{/number}","pulls_url":"https://api.github.com/repos/m-g-sonar/sonar-java/pulls{/number}","milestones_url":"https://api.github.com/repos/m-g-sonar/sonar-java/milestones{/number}","notifications_url":"https://api.github.com/repos/m-g-sonar/sonar-java/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/m-g-sonar/sonar-java/labels{/name}","releases_url":"https://api.github.com/repos/m-g-sonar/sonar-java/releases{/id}","created_at":"2015-01-20T10:39:06Z","updated_at":"2015-01-20T14:47:13Z","pushed_at":"2015-01-30T17:10:58Z","git_url":"git://github.com/m-g-sonar/sonar-java.git","ssh_url":"git@github.com:m-g-sonar/sonar-java.git","clone_url":"https://github.com/m-g-sonar/sonar-java.git","svn_url":"https://github.com/m-g-sonar/sonar-java","homepage":"","size":9211,"stargazers_count":0,"watchers_count":0,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":0,"forks":0,"open_issues":0,"watchers":0,"default_branch":"master"}},"base":{"label":"SonarSource:master","ref":"master","sha":"fb97138256699b618229fee0b072d31303bdf19f","user":{"login":"SonarSource","id":545988,"avatar_url":"https://avatars.githubusercontent.com/u/545988?v=3","gravatar_id":"","url":"https://api.github.com/users/SonarSource","html_url":"https://github.com/SonarSource","followers_url":"https://api.github.com/users/SonarSource/followers","following_url":"https://api.github.com/users/SonarSource/following{/other_user}","gists_url":"https://api.github.com/users/SonarSource/gists{/gist_id}","starred_url":"https://api.github.com/users/SonarSource/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SonarSource/subscriptions","organizations_url":"https://api.github.com/users/SonarSource/orgs","repos_url":"https://api.github.com/users/SonarSource/repos","events_url":"https://api.github.com/users/SonarSource/events{/privacy}","received_events_url":"https://api.github.com/users/SonarSource/received_events","type":"Organization","site_admin":false},"repo":{"id":5674787,"name":"sonar-java","full_name":"SonarSource/sonar-java","owner":{"login":"SonarSource","id":545988,"avatar_url":"https://avatars.githubusercontent.com/u/545988?v=3","gravatar_id":"","url":"https://api.github.com/users/SonarSource","html_url":"https://github.com/SonarSource","followers_url":"https://api.github.com/users/SonarSource/followers","following_url":"https://api.github.com/users/SonarSource/following{/other_user}","gists_url":"https://api.github.com/users/SonarSource/gists{/gist_id}","starred_url":"https://api.github.com/users/SonarSource/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/SonarSource/subscriptions","organizations_url":"https://api.github.com/users/SonarSource/orgs","repos_url":"https://api.github.com/users/SonarSource/repos","events_url":"https://api.github.com/users/SonarSource/events{/privacy}","received_events_url":"https://api.github.com/users/SonarSource/received_events","type":"Organization","site_admin":false},"private":false,"html_url":"https://github.com/SonarSource/sonar-java","description":"","fork":false,"url":"https://api.github.com/repos/SonarSource/sonar-java","forks_url":"https://api.github.com/repos/SonarSource/sonar-java/forks","keys_url":"https://api.github.com/repos/SonarSource/sonar-java/keys{/key_id}","collaborators_url":"https://api.github.com/repos/SonarSource/sonar-java/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/SonarSource/sonar-java/teams","hooks_url":"https://api.github.com/repos/SonarSource/sonar-java/hooks","issue_events_url":"https://api.github.com/repos/SonarSource/sonar-java/issues/events{/number}","events_url":"https://api.github.com/repos/SonarSource/sonar-java/events","assignees_url":"https://api.github.com/repos/SonarSource/sonar-java/assignees{/user}","branches_url":"https://api.github.com/repos/SonarSource/sonar-java/branches{/branch}","tags_url":"https://api.github.com/repos/SonarSource/sonar-java/tags","blobs_url":"https://api.github.com/repos/SonarSource/sonar-java/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/SonarSource/sonar-java/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/SonarSource/sonar-java/git/refs{/sha}","trees_url":"https://api.github.com/repos/SonarSource/sonar-java/git/trees{/sha}","statuses_url":"https://api.github.com/repos/SonarSource/sonar-java/statuses/{sha}","languages_url":"https://api.github.com/repos/SonarSource/sonar-java/languages","stargazers_url":"https://api.github.com/repos/SonarSource/sonar-java/stargazers","contributors_url":"https://api.github.com/repos/SonarSource/sonar-java/contributors","subscribers_url":"https://api.github.com/repos/SonarSource/sonar-java/subscribers","subscription_url":"https://api.github.com/repos/SonarSource/sonar-java/subscription","commits_url":"https://api.github.com/repos/SonarSource/sonar-java/commits{/sha}","git_commits_url":"https://api.github.com/repos/SonarSource/sonar-java/git/commits{/sha}","comments_url":"https://api.github.com/repos/SonarSource/sonar-java/comments{/number}","issue_comment_url":"https://api.github.com/repos/SonarSource/sonar-java/issues/comments/{number}","contents_url":"https://api.github.com/repos/SonarSource/sonar-java/contents/{+path}","compare_url":"https://api.github.com/repos/SonarSource/sonar-java/compare/{base}...{head}","merges_url":"https://api.github.com/repos/SonarSource/sonar-java/merges","archive_url":"https://api.github.com/repos/SonarSource/sonar-java/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/SonarSource/sonar-java/downloads","issues_url":"https://api.github.com/repos/SonarSource/sonar-java/issues{/number}","pulls_url":"https://api.github.com/repos/SonarSource/sonar-java/pulls{/number}","milestones_url":"https://api.github.com/repos/SonarSource/sonar-java/milestones{/number}","notifications_url":"https://api.github.com/repos/SonarSource/sonar-java/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/SonarSource/sonar-java/labels{/name}","releases_url":"https://api.github.com/repos/SonarSource/sonar-java/releases{/id}","created_at":"2012-09-04T15:53:13Z","updated_at":"2015-01-30T17:15:45Z","pushed_at":"2015-01-30T17:15:45Z","git_url":"git://github.com/SonarSource/sonar-java.git","ssh_url":"git@github.com:SonarSource/sonar-java.git","clone_url":"https://github.com/SonarSource/sonar-java.git","svn_url":"https://github.com/SonarSource/sonar-java","homepage":"","size":24501,"stargazers_count":30,"watchers_count":30,"language":"Java","has_issues":false,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":58,"mirror_url":null,"open_issues_count":5,"forks":58,"open_issues":5,"watchers":30,"default_branch":"master"}},"_links":{"self":{"href":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28"},"html":{"href":"https://github.com/SonarSource/sonar-java/pull/28"},"issue":{"href":"https://api.github.com/repos/SonarSource/sonar-java/issues/28"},"comments":{"href":"https://api.github.com/repos/SonarSource/sonar-java/issues/28/comments"},"review_comments":{"href":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28/comments"},"review_comment":{"href":"https://api.github.com/repos/SonarSource/sonar-java/pulls/comments/{number}"},"commits":{"href":"https://api.github.com/repos/SonarSource/sonar-java/pulls/28/commits"},"statuses":{"href":"https://api.github.com/repos/SonarSource/sonar-java/statuses/dcc60cbc8a06049d8aabe08d44ff6a87c00ecb5d"}}}}