dhhxu/projectscope

View on GitHub
app/assets/javascripts/slack_graphic.js

Summary

Maintainability
C
1 day
Test Coverage

Function SlackGraphic has a Cognitive Complexity of 17 (exceeds 5 allowed). Consider refactoring.
Open

var SlackGraphic = function(projectID, slackURL) {
  this.slackURL = slackURL;
  this.getSlackData = function() {
    jQuery.ajax({type: 'GET',
            url: this.slackURL,
Severity: Minor
Found in app/assets/javascripts/slack_graphic.js - About 2 hrs to fix

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

  • Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
  • Code is considered more complex for each "break in the linear flow of the code"
  • Code is considered more complex when "flow breaking structures are nested"

Further reading

Function SlackGraphic has 48 lines of code (exceeds 25 allowed). Consider refactoring.
Open

var SlackGraphic = function(projectID, slackURL) {
  this.slackURL = slackURL;
  this.getSlackData = function() {
    jQuery.ajax({type: 'GET',
            url: this.slackURL,
Severity: Minor
Found in app/assets/javascripts/slack_graphic.js - About 1 hr to fix

    Function showSlackGraphic has 35 lines of code (exceeds 25 allowed). Consider refactoring.
    Open

      this.showSlackGraphic = function(jsonData, requestStatus, xhrObject) {
        if (jsonData.length == 0) {
          jQuery('#'+projectID+'-slack').html('<p class="bg-danger">No Slack Found</p>');
          return(false);
        }
    Severity: Minor
    Found in app/assets/javascripts/slack_graphic.js - About 1 hr to fix

      Function drawSlackGraphic has 27 lines of code (exceeds 25 allowed). Consider refactoring.
      Open

          function drawSlackGraphic() {
              var slackData = new google.visualization.DataTable();
              var numUsers = jsonData.length;
              var numColumns = 3;
              var numRows = Math.ceil(numUsers / numColumns);
      Severity: Minor
      Found in app/assets/javascripts/slack_graphic.js - About 1 hr to fix

        Unexpected alert.
        Open

                    error: function(xhrObj, textStatus, exception) { alert('Slack Graphic Error! '

        Disallow Use of Alert (no-alert)

        JavaScript's alert, confirm, and prompt functions are widely considered to be obtrusive as UI elements and should be replaced by a more appropriate custom UI implementation. Furthermore, alert is often used while debugging code, which should be removed before deployment to production.

        alert("here!");

        Rule Details

        This rule is aimed at catching debugging code that should be removed and popup UI elements that should be replaced with less obtrusive, custom UIs. As such, it will warn when it encounters alert, prompt, and confirm function calls which are not shadowed.

        Examples of incorrect code for this rule:

        /*eslint no-alert: "error"*/
        
        alert("here!");
        
        confirm("Are you sure?");
        
        prompt("What's your name?", "John Doe");

        Examples of correct code for this rule:

        /*eslint no-alert: "error"*/
        
        customAlert("Something happened!");
        
        customConfirm("Are you sure?");
        
        customPrompt("Who are you?");
        
        function foo() {
            var alert = myCustomLib.customAlert;
            alert();
        }

        Related Rules

        Expected '===' and instead saw '=='.
        Open

            if (jsonData.length == 0) {

        Require === and !== (eqeqeq)

        It is considered good practice to use the type-safe equality operators === and !== instead of their regular counterparts == and !=.

        The reason for this is that == and != do type coercion which follows the rather obscure Abstract Equality Comparison Algorithm. For instance, the following statements are all considered true:

        • [] == false
        • [] == ![]
        • 3 == "03"

        If one of those occurs in an innocent-looking statement such as a == b the actual problem is very difficult to spot.

        Rule Details

        This rule is aimed at eliminating the type-unsafe equality operators.

        Examples of incorrect code for this rule:

        /*eslint eqeqeq: "error"*/
        
        if (x == 42) { }
        
        if ("" == text) { }
        
        if (obj.getStuff() != undefined) { }

        The --fix option on the command line automatically fixes some problems reported by this rule. A problem is only fixed if one of the operands is a typeof expression, or if both operands are literals with the same type.

        Options

        always

        The "always" option (default) enforces the use of === and !== in every situation (except when you opt-in to more specific handling of null [see below]).

        Examples of incorrect code for the "always" option:

        /*eslint eqeqeq: ["error", "always"]*/
        
        a == b
        foo == true
        bananas != 1
        value == undefined
        typeof foo == 'undefined'
        'hello' != 'world'
        0 == 0
        true == true
        foo == null

        Examples of correct code for the "always" option:

        /*eslint eqeqeq: ["error", "always"]*/
        
        a === b
        foo === true
        bananas !== 1
        value === undefined
        typeof foo === 'undefined'
        'hello' !== 'world'
        0 === 0
        true === true
        foo === null

        This rule optionally takes a second argument, which should be an object with the following supported properties:

        • "null": Customize how this rule treats null literals. Possible values:
          • always (default) - Always use === or !==.
          • never - Never use === or !== with null.
          • ignore - Do not apply this rule to null.

        smart

        The "smart" option enforces the use of === and !== except for these cases:

        • Comparing two literal values
        • Evaluating the value of typeof
        • Comparing against null

        Examples of incorrect code for the "smart" option:

        /*eslint eqeqeq: ["error", "smart"]*/
        
        // comparing two variables requires ===
        a == b
        
        // only one side is a literal
        foo == true
        bananas != 1
        
        // comparing to undefined requires ===
        value == undefined

        Examples of correct code for the "smart" option:

        /*eslint eqeqeq: ["error", "smart"]*/
        
        typeof foo == 'undefined'
        'hello' != 'world'
        0 == 0
        true == true
        foo == null

        allow-null

        Deprecated: Instead of using this option use "always" and pass a "null" option property with value "ignore". This will tell eslint to always enforce strict equality except when comparing with the null literal.

        ["error", "always", {"null": "ignore"}]

        When Not To Use It

        If you don't want to enforce a style for using equality operators, then it's safe to disable this rule. Source: http://eslint.org/docs/rules/

        'i' is already defined.
        Open

                for (var i = 0; i < numRows; i++) {

        disallow variable redeclaration (no-redeclare)

        In JavaScript, it's possible to redeclare the same variable name using var. This can lead to confusion as to where the variable is actually declared and initialized.

        Rule Details

        This rule is aimed at eliminating variables that have multiple declarations in the same scope.

        Examples of incorrect code for this rule:

        /*eslint no-redeclare: "error"*/
        
        var a = 3;
        var a = 10;

        Examples of correct code for this rule:

        /*eslint no-redeclare: "error"*/
        
        var a = 3;
        // ...
        a = 10;

        Options

        This rule takes one optional argument, an object with a boolean property "builtinGlobals". It defaults to false. If set to true, this rule also checks redeclaration of built-in globals, such as Object, Array, Number...

        builtinGlobals

        Examples of incorrect code for the { "builtinGlobals": true } option:

        /*eslint no-redeclare: ["error", { "builtinGlobals": true }]*/
        
        var Object = 0;

        Examples of incorrect code for the { "builtinGlobals": true } option and the browser environment:

        /*eslint no-redeclare: ["error", { "builtinGlobals": true }]*/
        /*eslint-env browser*/
        
        var top = 0;

        The browser environment has many built-in global variables (for example, top). Some of built-in global variables cannot be redeclared. Source: http://eslint.org/docs/rules/

        Similar blocks of code found in 4 locations. Consider refactoring.
        Open

          this.getSlackData = function() {
            jQuery.ajax({type: 'GET',
                    url: this.slackURL,
                    timeout: 5000,
                    success: this.showSlackGraphic,
        Severity: Major
        Found in app/assets/javascripts/slack_graphic.js and 3 other locations - About 2 hrs to fix
        app/assets/javascripts/pivotal_tracker_graphic.js on lines 3..13
        app/assets/javascripts/pull_request_graphic.js on lines 3..13
        app/assets/javascripts/slack_trend_graphic.js on lines 3..15

        Duplicated Code

        Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

        Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

        When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

        Tuning

        This issue has a mass of 93.

        We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

        The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

        If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

        See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

        Refactorings

        Further Reading

        There are no issues that match your filters.

        Category
        Status